编码规范
玛丽莲梦兔
637次浏览
2020年07月28日 23:45
最佳经验
本文由作者推荐
眨眼英文-乖僻
2、缩进使用tab，不能使用空格，编辑器的tab都调到4字符宽。
3、所有的结构体全部使用大写字母，单词间用下划线“_”分隔。
4、所有的类使用各单词首字母大写。
5、全局变量使用“g_”前缀，文件内静态变量使用“s_”前缀。
5、结构体的成员变量一律小写。第二单词开始首字母大写，或字母间使用下划线。
（但同一个文件中只能使用其中一种）
6、类的成员变量使用“m_”做前缀。之后的首单词小写。第二单词开始的规范同结构体的成员变量。
7、函数名首字母小写，第二单词开始首字母大写，或字母间使用下划线。
（但同一文件中只能使用其中一种）
7、if/else 后的语句如果和 if/else 在同一行可以省略大括号，否则必须加大括号。
8、文件结尾要有至少一个空行（否则gcc中会报warnning）
9、变量、类型、函数取名时要有意义，要易懂。
类型名、变量名应该是名词或名词性短语，函数名应该是动词或动宾短语。
10、编译时warnning都要消除。
11、函数不得过长，不得超过100行，尽量控制在1屏左右。
12、代码的一行不得过长，应该控制在80到100字符左右，超出后应该折行。
13、类型、类、输出函数、全局变量，必须有注释，说明用途、用法。
程序中主要的步骤、算法等也要加注释说明。
14、每个文件开头要有文件说明、文件的作者、创建时间。
重要维护或者更换了维护人之后要增加维护记录。
文件除了文件头中声明的人外，其他人不应该随意更改。