C_C++语言编码规范.docVIP

C/C++语言编码规范 目录 C/C++语言编码规范 1 目录 2 1. 命名规则 4 1.1. 起个合适的名字 4 1.1.1. 类的名称（适用于C++） 4 1.1.2. 方法和函数的名称（适用于C/C++） 4 1.1.3. 含有度量单位的名称（适用于C/C++） 4 1.1.4. 缩写名称不要全部大写（适用于C/C++） 4 1.2. 类的命名（适用于C++） 5 1.3. 类库（或程序库）命名 （适用于C/C++） 5 1.4. 方法和函数的命名（适用于C++） 5 1.5. 类属性的命名（适用于C++） 5 1.6. 方法和函数参数的命名（适用于C++） 6 1.7. 局部变量的命名（适用于C/C++） 6 1.8. 指针变量的命名前缀（适用于C/C++） 6 1.9. 引用变量和返回引用函数的命名前缀（适用于C++） 7 1.10. 全局变量的命名前缀（适用于C/C++） 7 1.11. 全局常量的命名（适用于C/C++） 7 1.12. 静态变量的命名前缀（适用于C++） 7 1.13. 自定义类型（typedef）的命名（适用于C/C++） 7 1.14. 宏定义的命名（适用于C/C++） 8 1.15. C 函数的命名（适用于C/C++） 8 1.16. 枚举的命名（适用于C/C++） 8 2. 排版规则 10 2.1. 布局和模板 10 2.1.1. 类的布局模板 （适用于C++） 10 2.1.2. 源文件格式（适用于C++） 11 2.1.3. 保护头文件不被重复包含 （适用于C/C++） 12 2.1.4. 方法和函数的布局 （适用于C/C++） 13 2.2. 缩进、制表符以及空格 （适用于C/C++） 13 2.3. 尽量使一行不要超过78个字母 （适用于C/C++） 13 2.4. 保证一行只写一条语句 （适用于C/C++） 13 2.5. 花括号 {} 规则 （适用于C/C++） 14 2.5.1. 花括号的位置 14 2.5.2. 什么时候应使用花括号 14 2.5.3. 在花括号结束的位置加上注释 14 2.5.4. 注意屏幕大小 15 2.6. 圆括号 () 规则 （适用于C/C++） 15 2.7. if else 语句的格式 （适用于C/C++） 15 2.8. switch 格式 （适用于C/C++） 16 2.9. 使用goto,continue,break 和 ?: （适用于C/C++） 16 2.9.1. Goto 16 2.9.2. Continue and Break 17 2.9.3. ?: 17 2.10. 运算符号的规则 （适用于C/C++） 17 2.11. 变量声明语句块 （适用于C/C++） 17 3. 文档及注释 19 3.1. 文件或程序库的文档注释（适用于C/C++） 19 3.2. 类文档注释（适用于C/C++） 19 3.3. 函数文档注释（适用于C/C++） 19 3.4. Include 语句注释 （适用于C/C++） 20 3.5. 语句块注释（适用于C/C++） 20 4. 编码要求 22 4.1. 不要忽略编译器的警告（适用于C/C++） 22 4.2. 应使用源代码管理器（适用于C/C++） 22 4.3. 固有的类方法成员（适用于C++） 22 4.4. 使用命名空间 （适用于C++） 22 4.5. 初始化所有的变量 （适用于C/C++） 22 4.6. 保持函数短小精悍（适用于C/C++） 22 4.7. 对空语句进行注释 （适用于C/C++） 23 4.8. 不要用if语句的默认方法测试非零值（适用于C/C++） 23 4.9. 布尔类型 （适用于C/C++） 23 4.10. 避免在语句中内含赋值 （适用于C/C++） 24 4.11. 正确的使用Const （适用于C/C++） 24 4.12. 不要在头文件定义数据 （适用于C/C++） 24 4.13. 不要直接使用数字 （适用于C/C++） 24 4.14. 宏（适用于C/C++） 25 命名规则 起个合适的名字 类的名称（适用于C++） 类的名字不需要告诉我们，它从哪个类继承而来的。 有时候加个后缀是很有用的。比如类是一个代理(Agents)时，起名叫DownloadAgent更能表达真实的意图。 方法和函数的名称（适用于C/C++） CheckForErrors() 而不是ErrorCheck(), DumpDataToFile() 而不是 DataFile()。 这样也可以很容易的区别函数和数据。 函数名总以动词开头，后面跟随其它名称。这样看起来更自然些。 可以加一些必要的后缀： Max – 表示取最大值 Cnt – 表示当前的计数值