Skip to content

Latest commit

 

History

History
25 lines (25 loc) · 1.29 KB

codestyle.md

File metadata and controls

25 lines (25 loc) · 1.29 KB

代码规范

缩进规则

四个空格的缩进(编辑器可以自动完成)

变量命名

不使用字母l和O作为单字符变量名

每行最多字符数

限制最大字符数为80

函数、类命名

函数名,类名以驼峰命名法(不用下划线)

常量

常量采用全大写的方式命名

空行规则

相对独立的程序块之间、变量说明之后必须加空行

注释规则

注释也需要与代码一样整齐排版 1)注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。 2)注释与所描述内容进行同样的缩排。 3)将注释与其上面的代码用空行隔开。 4)变量、常量、宏的注释应放在其上方相邻位置或右方。

操作符前后空格

逗号后面要加空格,如果后面是小括号,则不用。 冒号前不加空格,冒号后要加空格,但在切片里,前后都不用加空格。 “#”后要加一个空格。 二元运算符前后都需要加空格,但作为函数参数时=前后不需要加空格。 如果使用具有不同优先级的运算符,只在具有最低优先等级的运算符周围两边添加空格,其他的就不用加了。