01. 注释的作用

在大多数编程语言中,注释都是一项很有用的功能。在一些简单的程序中只包含Python代码,但随着程序越来越大、越来越复杂,就应在其中添加说明,对你解决问题的方法进行大致的阐述。注释让你能够使用熟悉的自然语言在程序中添加说明,增强程序的可读性。

以下截图是一份python游戏的代码,仔细观察没有一个中文字,如果这份代码相当复杂,阅读就会变得很困难。

在开发项目期间,你对各个部分如何协同工作了如指掌,但过段时间后,有些细节你可能不记得了。当然,你总是可以通过研究代码来确定各个部分的工作原理,但通过编写注释,以清晰的自然语言对解决方案进行概述,可节省很多时间。

02. 单行注释(行注释)

以 # 开头,# 后面的内容都会被Python解释器忽略,全部被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用。

# 这是第一个单行注释

print("hello python")

为了保证代码的可读性,# 后面建议先添加一个空格,然后再编写相应的说明文字。

一般都是在代码的上方写注释。

如果代码和注释都很短的情况下,同样可以使用#在代码的后面(旁边)增加说明性的文字。需要注意的是,为了保证代码的可读性,注释和代码之间 至少要有 两个空格。

示例代码如下:

print("hello python") # 输出 `hello python`

03. 多行注释(块注释)

如果希望编写的 注释信息很多,一行无法显示,就可以使用多行注释。

要在 Python 程序中使用多行注释,可以用 一对 连续的 三个 引号(单引号和双引号都可以)。

示例代码如下:

"""

这是一个多行注释

在多行注释之间,可以写很多很多的内容……

"""

print("hello python")

什么时候需要使用注释?

注释不是越多越好,对于一目了然的代码,不需要添加注释。

对于复杂的操作,应该在操作开始前写上若干行注释。

对于不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)。

绝不要描述代码,假设阅读代码的人比你更懂Python,他只是不知道你的代码要做什么。编写注释的主要目的是阐述代码要做什么,以及是如何做的。

要成为专业程序员或与其他程序员合作,就必须编写有意义的注释。当前,大多数软件都是合作编写的,编写者可能是同一家公司的多名员工,也可能是众多致力于同一个开源项目的人员。训练有素的程序员都希望代码中包含注释,因此你最好从现在开始就在程序中添加描述性注释。作为新手,最值得养成的习惯之一是,在代码中编写清晰、简洁的注释。

如果不确定是否要编写注释,就问问自己,找到合理的解决方案前,是否考虑了多个解决方案。如果答案是肯定的,就编写注释对你的解决方案进行说明吧。相比回过头去再添加注释,删除多余的注释要容易得多。

关于代码规范

虽然还没有开始写代码,但是可以收藏起来,时不时看一下,养成规范的代码格式,越早越好。

任何语言的程序员,编写出符合规范的代码,是开始程序生涯的第一步

python使用什么注释语句和运算-Python代码注释的用法和意义相关推荐

  1. python使用什么注释语句和运算-python 闯关之路一(语法基础)

    1,什么是编程?为什么要编程? 答:编程是个动词,编程就等于写代码,那么写代码是为了什么呢?也就是为什么要编程呢,肯定是为了让计算机帮我们搞事情,代码就是计算机能理解的语言. 2,编程语言进化史是什么 ...

  2. python使用什么注释语句和运算-Python中的注释符有哪几种?( )

    [单选题]以下程序的输出结果是________ s = "python 编程 很 容易 学" print(len(s)) [多选题]Python支持的数据类型有( ) [单选题]字 ...

  3. python使用什么注释语句和运算-Python基础之注释,算数运算符,变量,输入和格式化输出...

    Python的注释 注释的作用:用自己熟悉的语言,对某些代码进行标注说明,增强程序的可读性: 在python解释器解释代码的过程中,凡是#右边的,解释器都直接跳过这一行: 注释的分类 单行注释 # 这 ...

  4. python中使用什么注释语句和运算_Python基础知识

    本文标识 :Python_1 本文编辑 : Jack 风 编程工具 : Anaconda.Pycharm 阅读时长 : 12分钟 Python基础学习为什么那么多培训机构?那么多的程序员呢? 很简单啊 ...

  5. python使用什么注释语句和运算-怎么使用python注释语句

    注释的最大作用是提高程序的可读性,没有注释的程序简直就是天书,让人吐血! 千万不要认为你自己写的代码规范就可以不加注释,甩给别人一段没有注释的代码是对别人的不尊重,是非常自私的行为:你可以喜欢自 虐, ...

  6. MySQL注释形式_可执行注释语句(/*!...*/)_数据库注释_数据库脚本注释_SQL脚本注释格式_SQL脚本注释分类

    文章目录 单行注释 多行注释 可执行注释 为什么要把可执行的 SQL 语句写在注释里面呢? 注释示例 导入数据时禁止/激活索引 测试禁止索引再导入数据的效率 单行注释 SELECT * from tf ...

  7. 【代码注释】浅谈对于代码注释的理解

    楔子:"这里的山路十八弯,这里的水路九连环":智慧的古人就懂得,通过把山路修成九曲十八弯来战胜陡峭的高坡.看则舍近求远绕圈而行,实为拿路程换高度,为完成登顶而蓄势待发.这种螺旋上升 ...

  8. java 代码注释搞笑_搞笑的代码注释,那些有趣的程序员

    发表于 2019-04-24 16:11:26 by月小升 搞笑 /*** * .::::. * .::::::::. * ::::::::::: F*CK YOU * ..:::::::::::' ...

  9. html 搞笑代码注释,那些令人啼笑皆非的代码注释

    虾米音乐Mac版客户端中关于VIP会员代码的注释的图片在网上疯传,原因是里面出现了所谓的"穷逼VIP(活动送的那种)". 虾米音乐App前员工八座在知乎更新评论,"对不住 ...

最新文章

  1. BAT七年经验,却抵不过外企面试的两道算法题?
  2. Linux常用监控命令简介 – vmstat,ps,free,uptime 等
  3. Deactivate .NET refector
  4. [USACO4.2]Drainage Ditches
  5. 牛客网_PAT乙级_1023旧键盘打字(20)【别人代码里用到的hash是啥】
  6. Mathematica修改默认字体
  7. 表字段注释放在哪_橱柜台面6种材质优缺点大解剖,我来测评,告诉你哪一种适合你!...
  8. ghostwin10系统后不小心重新分区了,其它分区的资料如何找回
  9. 蓝桥杯2020山西省省赛太原理工大获丰收
  10. Android 代码中的常见的问题总结
  11. (时频分析学习)Week01:傅里叶级数,S变换与广义S变换
  12. python读取csmar_Python:爬取上市公司公告-Wind-CSMAR
  13. 函数-6已知输入为一个列表,列表中的元素都为整数,我们定义元素筛选函数为foo,功能是检查获取传入列表对象的所有奇数位索引(注意列表的索引是从0开始的)对应的元素,并将其作为新列表返回给调用者。
  14. 【MATLAB】三维绘图 三维数据插值
  15. 智能手机上最常见的传感器
  16. 基于微信小程序的点餐与预约餐桌的管理系统+后台管理
  17. PCA主成分分析(原理+例子)
  18. 机器人学:操作臂运动学(Manipulator Forward Kinematics)
  19. 【linux】04 ssh
  20. 在暑期实习时需要注意些什么

热门文章

  1. Chrome 39-45
  2. 博主谈:聊聊我们说的网站优化
  3. 2019寒假作业二:PTA7-1币值转换
  4. 【mongoDB实战】mongo对某个键添加索引
  5. HNU 2015暑期新队员训练赛2 H Blanket
  6. Asterisk 1.8 sip 协议栈分析
  7. HDOJ1035 ( Robot Motion ) 【递归】
  8. 《Java程序员职场全攻略:从小工到专家》连载十二:大家都是个什么身价
  9. python selenium过极验滑动验证码
  10. UI分层中使用PageFactory