项目代码规范
1 格式规范
1.1 行数和列数
1. 单个文件尽量不要超过 500 行(一些特殊功能类除外)。
2. 单个函数尽量不要超过 40 行,即在屏幕范围之内能完整显示。
3. 列数不超过 120,即每行最多 120 个 ASCII 码字符。
1.2 缩进
1. 代码块的缩进以四个空格为一个缩进单元,不使用制表符(文本编辑器中可设置输入 tab 时以四个空格代替)。
2. 合理使用 return、connue、break 等语句减少代码缩进,以保证代码的可读性。
1.3 断行
1. 当一行代码按照其他规范都合法,只是为了避免超出长度限制和显示范围而进行的换行,称为长行断行。
1.3.1 断行的原则
1. 断行时尽量选择在高一级的逻辑之间进行断行,以保证每行逻辑的完整性。
1.3.2 断行的选择
1. 当一个非赋值运算的语句断行时,在运算符号之前断行。
2. 当一个赋值运算语句断行时,一般在赋值符号之后断行。
3. 当调用函数或者构造函数需要断行时,与函数名相连的左括号要在一行,也就是在左括号之后断行。
4. 根据逗号断行时,在逗号之后断行。
1.3.3 断行的缩进
1. 断行新行缩进 4 个字符。
1.4 空行
1. 构成代码文件的四部分(版权说明、宏定义、使用的命名空间、源代码部分)中间使用一行空行分隔。
2. 类型定义时,第一个成员前和最后一个成员后使用一行空行分隔。
3. 定义变量(包括成员属性)时,一组变量(通常是有同一功能或者相同作用的多个变量)与另一组变量之间,使用一行
空行分隔。
4. 函数前后与其他内容使用一行空行分隔。
5. 函数内实现不同功能或作用的代码之间,使用一行空行分隔。
1.5 宏
1. 所有宏的定义及判断均没有任何缩进。
2. 如果有宏判断的嵌套,要在#endif 后面注释对应的#if 判断的宏的名称,并在注释前以空格分隔。
王银 1 / 4
评论0
最新资源