适当的注释:
- 在程序开头写一个 summary 来解释程序的功能、特点和技术方法等。
- 在较长的程序中应该为每一个主要步骤中可能比较难以读懂的部分写注释。注释应该尽量简洁以避免其挤在代码中难以阅读。
命名惯例
- 变量和函数名:驼峰式命名。例:
readDouble
- 类名:首字母大写,驼峰式。例:
GeometricObject
- 常量:所有字母大写,用下划线分割单词。如:
MAX_VALUE
- 单个item用单数形式,多个item用复数形式表示。如:
student
,counts = []
适当的空格与缩进:
固定的缩进风格可以让程序可读性更好。缩进用于解释程序的层次,推荐用4个空格来分割各个代码段。
用空格来分隔函数中的变量,但是要注意不要在函数中的圆括号两边加空格。如:
aMethod(a1, a2)
就很好(注意:只在逗号后面加一个空格),不要写成aMethod ( a1 , a1 )
。在二元运算符两边应该各加一个空格。如:
b = 3 + 4 * 4 > 5 * (4 + 3) - i
在代码段之间加空行来让程序更可读