上一节的程序ch2_1.py,尽管我们已经为变量设置了有意义的名称,但时间一久,还是会忘记各个指令的内涵。所以笔者建议,设计程序时,适度地为程序代码加上注释。此外,程序注释也可让你设计的程序可读性更高,更容易了解。在企业工作,一个实用的程序可以很轻易地超过几千或上万行,此时你可能需要设计好几个月,程序加上注释,可方便你或他人阅读,未来更便利地了解程序内容,同时设计的程序可以方便工程师们的交流与沟通。
不论是使用Python Shell直译器或是Python程序文档,"#"符号右边的文字,就是 程序注释 ,Python语言的直译器会忽略此符号右边的文字。可参考下列实例。
程序实例ch2_2.py: 重新设计程序ch2_1.py,为程序代码加上注释。
执行结果 与ch2_1.py相同。
经过上述注释后,即使再过10年,只要一看到程序,就可轻松了解整个程序的意义。
如果要进行大段落的注释,可以用三个单引号或双引号将注释文字标明。
程序实例ch2_3.py: 以三个单引号当作注释。
三个双引号间的文字也可以当段落注释,可参考所附的ch2_3_1.py文档。