1.5 良好的编程习惯
编写完成代码后,除了让计算机运行外,还需要提供良好的代码帮助阅读。
这里主要通过注释说明、良好的命名方式,为代码阅读提供更好的帮助。
1.注释说明
图1.2和图1.4中的代码,已经提供了代码注释说明,在代码开始部分“三酷猫的第一个程序”就是一个注释说明,它在代码运行时,并不被执行,仅供读者阅读理解。
Python语言提供了两种注释使用方法,如图1.6所示。

图1.6 Python的两种注释使用方法
1)多行注释说明
在Python语言里用三引号表示多行的注释内容,如图1.6所示的第2行代码三引号,表示多行注释开始;第3行注释说明了编程开始时间,第4行说明编程作者,第5行说明编程地点,第6行三引号表示多行注释说明结束。该多行注释说明,在该代码被执行时,并没有运行输出任何内容,如图1.6右下所示,说明该部分代码仅用于读者的阅读理解。
2)单行注释说明(https://www.daowen.com)
另外一种常用的单行注释说明,用“#”开始来说明一行代码内容,如图1.6所示的第7行代码右边,“#”后内容并不被执行,而仅用于说明左边代码的含义。
对于复杂的代码,读者一定要养成重点代码必须给予注释说明的良好习惯。
2.良好的命名方式
目前,编程界主推的代码命名规则有两种:驼峰命名规则、下划线命名规则。
1)驼峰命名规则
驼峰命名规则,就是对变量等进行命名时,采用英文单词首字母大写,其他字母小写的命名规则。如图1.7所示,第8行代码,变量ThreeCoolCats的三个英文单词Three、Cool、Cats的首字母都大写,其他字母小写,这样有利读者阅读理解,而第9、10行的变量命名则是“糟糕”的命名方式。

图1.7 命名规则
2)下划线命名规则
下划线命名规则,就是英文字母都为小写,英文单词之间用下划线隔离,如图1.7所示的第12行,这样主要为了方便读者阅读理解。