我的cpp编程规范

一、命名规范

变量和函数用有意义的名字，不要写 int a, b, c; 和 void f(int x); 而要写 int studentCount; 和 void calculateAverageScore(int studentId);。不同实体用不同风格，变量和函数用小驼峰，比如 maxValue、getScore()；类和结构体用大驼峰，比如 StudentInfo、BinaryTree；常量和宏用全大写下划线，比如 MAX_SIZE、PI；成员变量末尾加下划线，比如 name_、score_。避免单字母命名，循环变量 i、j、k 除外。

二、代码格式

缩进统一用 4 个空格，不要用 Tab，因为不同编辑器 Tab 宽度不同。大括号风格用 K&R 风格，也就是左括号不换行，if 和 else 都跟左括号在同一行，函数定义时左括号可以换行，关键不是选哪种，而是全项目统一。运算符两边加空格，不要写 int sum=a+b*c; 而要写 int sum = a + b * c;。每行不要太长，建议不超过 100 字符，太长了就换行，把参数对齐。

三、注释规范

注释写"为什么"，不是"是什么"，不要写"把 a 加 1"，而要写"补偿数组下标从 0 开始的偏移"。函数头注释写清楚功能、参数和返回值，用 @brief、@param、@return 这种格式。及时更新注释，过期的注释比没有注释更可怕。

四、头文件与源文件

头文件保护用 #ifndef、#define、#endif 三件套，或者用 #pragma once，前者标准，后者简单。头文件只放声明，不放实现，类的成员函数在头文件里声明，在 cpp 文件里实现。include 顺序：先 include 对应的头文件，再 C 标准库，再 C++ 标准库，再第三方库，最后自己项目的头文件，每组之间空一行。