为程序添加注释可以用来解释程序某些部分的作用和功能,提高程序的可读性。除此之外,注释也是调试程序的重要方式。在某些时候,我们不希望编译、执行程序中的某些代码,这时就可以将这些代码注释掉。
当然,添加注释的最大作用还是提高程序的可读性!很多时候,笔者宁愿自己写一个应用,也不愿意去改进别人的应用,没有合理的注释是一个重要原因。
虽然良好的代码可自成文挡,但我们永远也不清楚今后读这段代码的人是谁,他是否和你有相同的思路。或者一段时间以后,你自己也不清楚当时写这段代码的目的了。通常而言,合理的代码注释应该占源代码的 1/3 左右。
Python 语言允许在任何地方插入空字符或注释,但不能插入到标识符和字符串中间。
Python 源代码的注释有两种形式,分别是单行注释和多行注释:
Python 使用井号(#)表示单行注释的开始,跟在“#”号后面直到这行结束为止的代码都将被解释器忽略。单行注释就是在程序中注释一行代码,在Python 程序中将井号(#)放在需要注释的内容之前就可以了。
多行注释是指一次性将程序中的多行代码注释掉,在 Python 程序中使用三个单引号或三个双引号将注释的内容括起来。
下面代码中增加了单行注释和多行注释:
#这是一行简单的注释 print ("Hello World!") ''' 这里面的内容全部是多行注释 Python语言真的很简单 ''' # print("这行代码被注释了,将不会被编译、执行!") """ 这是用三个双引号括起来的多行注释 Python 同样是允许的 """
上面程序中的这些注释部分对程序本身没有任何影响,注释内容的主要作用就是“给人看”,向人提供一些说明信息,Python 解释器会忽略这些注释内容。
此外,添加注释也是调试程序的一个重要方法。如果觉得某段代码可能有问题,可以先把这段代码注释起来,让 Python 解释器忽略这段代码,再次编译、运行,如果程序可以正常执行,则可以说明错误就是由这段代码引起的,这样就缩小了错误所在的范围,有利于排错;如果依然出现相同的错误,则可以说明错误不是由这段代码引起的,同样也缩小了错误所在的范围。