-
缩进
每一行开始处的缩进只能用Tab。输入内容之后统一用空格。除了最开始的缩进控制用Tab,其他部分为了对齐,需要使用空格进行缩进。
-
变量命名
标识符组成:标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确,避免用拼音命名。
最小化长度 && 最大化信息量原则:在保持一个标识符意思明确的同时,应当尽量缩短其长度。
避免过于相似:不要出现仅靠大小写区分的相似的标识符,例如"i"与"I"
,"function"
与"Function"
等等。
-
每行最多字符数
每一行代码字符数不超过 80
-
函数、类命名
同一性:在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性。
-
常量
变量 (包括函数参数) 和数据成员名一律小写, 单词之间用下划线连接。
-
空行规则
垂直留白越少越好
-
注释规则
关键函数必须写上注释,说明函数的用途。
键代码注释,包括但不限于:赋值,函数调用,表达式,分支等等。
-
操作符前后空格
左右添加空格
-
其他规则
一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
在代码行的结尾部分不能出现多余的空格。