C&C++编程规范（超级实用）

1. 文件结构 1.1 版权和版本的声明 1.2 头文件的结构 1.3 定义文件的结构 1.4 目录结构 2. 程序版式 2.1 空行 2.2 代码行 2.3 代码行内的空格 2.4 对齐 2.5 长行拆分 2.6 修饰符的位置 2.7 注释 2.8 类的版式 3 命名规则 3.1 共性规则 3.2 Windows 应用程序命名规则 3.3 Linux 应用程序函数命名规则 4. 表达式和基本语句 4.1 运算符的优先级 4.2 复合表达式 4.3 if 语句 4.3.1 布尔变量与零值比较 4.3.2 整型变量与零值比较 4.3.3 浮点变量与零值比较 4.3.4 指针变量与零值比较 4.4 循环语句的效率 4.5 for 语句的循环控制变量 4.6 switch 语句 4.7 goto 语句 5. 常量 5.1 const 与#define 的比较 5.2 常量定义规则 6. 函数设计 6.1 参数的规则 6.2 返回值的规则 6.3 函数内部实现的规则 6.4 其它建议 6.5 使用断言 6.6 引用与指针的比较 软件测试系列 7 重载和内联 7.1 普通函数重载 7.2 内联 ### C&C++编程规范详解 #### 一、文件结构 **1.1 版权和版本的声明** 在每个源文件的顶部，应包含版权信息和版本声明。这有助于明确代码的所有权以及跟踪代码的变更历史。 示例： ```cpp // Copyright (c) [YEAR] [COMPANY NAME] // // Version: 1.0.0 // Date: [DATE] // Author: [AUTHOR NAME] ``` **1.2 头文件的结构** 头文件通常用于声明类、函数等。其结构应该清晰明了，并且应该包含防止多次包含的保护措施。 示例： ```cpp #ifndef HEADER_FILE_NAME_H #define HEADER_FILE_NAME_H // Function declarations void someFunction(); #endif // HEADER_FILE_NAME_H ``` **1.3 定义文件的结构** 定义文件中包含了具体的实现细节，应该遵循一定的格式来提高可读性和维护性。 示例： ```cpp #include "header_file_name.h" void someFunction() { // Implementation details } ``` **1.4 目录结构** 良好的目录结构有助于代码管理。例如，可以按照功能模块进行分类。 示例： ``` project/ ├── include/ │ ├── header_file1.h │ └── header_file2.h ├── src/ │ ├── source_file1.cpp │ └── source_file2.cpp └── tests/ ├── test_file1.cpp └── test_file2.cpp ``` #### 二、程序版式 **2.1 空行** 适当的空行可以帮助提高代码的可读性。例如，在不同的逻辑块之间添加空行。 示例： ```cpp int main() { int x = 10; if (x > 0) { printf("Positive\n"); } return 0; } ``` **2.2 代码行** 每行代码不应过长，通常建议限制在80个字符左右。 **2.3 代码行内的空格** 为了增强可读性，应该在操作符和关键字前后添加空格。 示例： ```cpp if (value == 0) { // Do something } ``` **2.4 对齐** 使用对齐可以使代码更加整洁。 示例： ```cpp int a = 10; float b = 20.5; char c = 'A'; ``` **2.5 长行拆分** 对于超过推荐长度的长行，应进行合理拆分。 示例： ```cpp std::string long_variable_name = "This is a very long string that needs to be split " "because it exceeds the recommended length."; ``` **2.6 修饰符的位置** 类成员的访问修饰符应该放在显眼的位置，便于阅读。 示例： ```cpp class MyClass { public: void publicMethod(); private: void privateMethod(); }; ``` **2.7 注释** 注释应该简洁明了，避免冗余。 示例： ```cpp // Calculate the sum of two numbers int add(int a, int b) { return a + b; } ``` **2.8 类的版式** 类的结构应该清晰地组织起来，以便于理解和维护。 示例： ```cpp class MyClass { public: MyClass(); ~MyClass(); void someMethod(); private: int m_value; }; ``` #### 三、命名规则 **3.1 共性规则** 命名应具有描述性，并遵循一致的风格。 示例： - 变量名：`myVariableName` - 函数名：`myFunctionName` **3.2 Windows 应用程序命名规则** 在Windows环境下，通常采用驼峰命名法或下划线命名法。 示例： - 驼峰命名法：`myVariableName` - 下划线命名法：`my_variable_name` **3.3 Linux 应用程序函数命名规则** Linux环境下的函数命名通常采用下划线命名法。 示例： - `my_function_name` #### 四、表达式和基本语句 **4.1 运算符的优先级** 理解运算符的优先级有助于编写正确的表达式。 示例： ```cpp int result = 10 * 5 - 3; // result will be 47 ``` **4.2 复合表达式** 复合表达式应确保易于理解，并正确使用括号来调整运算顺序。 示例： ```cpp int result = (10 * 5) - 3; // Same as above ``` **4.3 if 语句** **4.3.1 布尔变量与零值比较** 布尔变量应直接使用而无需与0或非0值比较。 示例： ```cpp bool b = true; if (b) { /* ... */ } ``` **4.3.2 整型变量与零值比较** 整型变量应使用`== 0`或`!= 0`来进行比较。 示例： ```cpp int i = 0; if (i == 0) { /* ... */ } ``` **4.3.3 浮点变量与零值比较** 浮点数不精确，应使用一个很小的正数作为误差范围进行比较。 示例： ```cpp float f = 0.0f; if (fabs(f) < 0.00001) { /* ... */ } ``` **4.3.4 指针变量与零值比较** 指针与NULL比较时应使用`== NULL`或`!= NULL`。 示例： ```cpp void* p = NULL; if (p != NULL) { /* ... */ } ``` **4.4 循环语句的效率** 选择合适的循环类型和优化循环条件可以显著提高性能。 示例： ```cpp for (int i = 0; i < n; ++i) { // Do something efficient } ``` **4.5 for 语句的循环控制变量** 循环控制变量应该简单明了，并且尽量减少在循环体中的使用。 示例： ```cpp for (int i = 0; i < 10; ++i) { // Use i directly } ``` **4.6 switch 语句** 使用`switch`语句时，应考虑所有可能的情况，并且使用`default`分支处理未预期的情况。 示例： ```cpp switch (dayOfWeek) { case 0: cout << "Sunday"; break; case 1: cout << "Monday"; break; // ... default: cout << "Invalid day"; } ``` **4.7 goto 语句** 尽量避免使用`goto`语句，除非它可以显著简化复杂的逻辑。 示例： ```cpp if (condition1) { // Do something } else { goto end; } end: ``` #### 五、常量 **5.1 const 与#define 的比较** 使用`const`定义常量可以提供类型安全，并且更容易被编译器优化。 示例： ```cpp const int MAX_SIZE = 100; ``` **5.2 常量定义规则** 常量名应使用大写字母，并使用下划线分隔单词。 示例： ```cpp const int MAX_VALUE = 100; ``` #### 六、函数设计 **6.1 参数的规则** 函数参数应尽可能少，并且类型应该简单。 示例： ```cpp void swap(int& a, int& b); ``` **6.2 返回值的规则** 返回值应该有意义，并且尽可能使用`bool`类型表示成功或失败。 示例： ```cpp bool divide(int dividend, int divisor, int& quotient); ``` **6.3 函数内部实现的规则** 函数内部应保持简洁，避免过于复杂的逻辑。 示例： ```cpp int add(int a, int b) { return a + b; } ``` **6.4 其它建议** 函数应该有一个明确的目的，并且易于理解和维护。 **6.5 使用断言** 断言可用于调试过程中检查假设是否成立。 示例： ```cpp assert(x > 0); ``` **6.6 引用与指针的比较** 引用通常更安全且易于使用，但在某些情况下指针是必要的。 示例： ```cpp void func1(int& ref); void func2(int* ptr); ``` #### 七、重载和内联 **7.1 普通函数重载** 通过重载可以为同一个函数名提供多种实现方式。 示例： ```cpp void myFunc(int a); void myFunc(double a); ``` **7.2 内联** 内联函数可以在编译时被替换为相应的代码，从而提高运行效率。 示例： ```cpp inline int square(int x) { return x * x; } ``` 这些规则和指导原则将帮助开发者编写出高质量、易于维护的C/C++代码。通过遵循这些规范，可以显著提升代码的可读性和可维护性，同时减少潜在的错误和问题。