在程序中加入注释,能使程序更加容易被看懂,也便于交流和协同工作。
单行注释程序示例:
,
独立单行注释,要求与当前代码行的缩进相匹配;代码行尾单行注释在一行代码最后,不可以在一行代码行中间。
用多行独立单行注释实现多行注释,示例:
,
多行的注释,每行要求与当前代码行的缩进相匹配并且对齐。
不管单行注释还是多行注释,Python解释器都是忽略掉的,就是说Python解释器根本就不知道有注释。如果你想让Python解释器也知道有注释,就要用文档字符串来注明了。Python解释器会把文档字符串记录下来作为文本资料,不进行解释执行;如果用户向Python解释器查询这些文档字符串,它会呈现给用户的。
文档字符串示例:
,
结果打印:
。
可见,文档字符串是一对三单引号或一对三双引号围起来的文档,换行符和空格都认为是文档字符串的组成部分。开头的三引号需要与代码的缩进相对齐,内容和末三引号都没有这个要求。文档字符串不能添加在代码行后面,至少要独自一行。全局文档字符串用(__doc__)访问;类或函数中的文档字符串就要在(__doc__)添加类或函数民(如fun.__doc__)。不过,如果想让程序更加规范,需要遵守约定俗成的规则。
第一行应该是对象目的的简要概述。为简洁起见,它不应显式声明对象的名称或类型,因为这些可通过其他方式获得(除非名称恰好是描述函数操作的动词)。这一行应以大写字母开头,以句点结尾。
如果文档字符串中有更多行,则第二行应为空白,从而在视觉上将摘要与其余描述分开。后面几行应该是一个或多个段落,描述对象的调用约定,它的副作用等。
Python 解析器不会从 Python 中删除多行字符串文字的缩进,因此处理文档的工具必须在需要时删除缩进。这是使用以下约定完成的。文档字符串第一行 之后 的第一个非空行确定整个文档字符串的缩进量。(我们不能使用第一行,因为它通常与字符串的开头引号相邻,因此它的缩进在字符串文字中不明显。)然后从字符串的所有行的开头剥离与该缩进 "等效" 的空格。缩进更少的行不应该出现,但是如果它们出现,则应该剥离它们的所有前导空格。应在转化制表符为空格后测试空格的等效性(通常转化为8个空格)。
规矩示例:
,
结果打印:
。
添加注释的“要”与“不要”:
要很明确地说明代码实现的功能;
不要每行代码都写注释;
不要写废话,简单明了就可以了;
不要写错误的注释,写注释一定要认真,错误注释会给自己和别人带来困扰;
不要把真正的代码给注释掉了。