代码规范

我这学期的 C++ 代码规范

这学期主要使用 C++ 完成算法学习和编程作业。我希望自己的代码不仅能够正确运行，也能做到结构清楚、命名统一，方便检查和修改。结合平时的编程习惯，我为自己制定了以下规范。
一、命名规范

1. 变量和函数采用小驼峰命名法，例如 studentCount、maxValue、calculateSum。名称尽量使用有意义的英文单词，避免拼音和难以理解的缩写。
2. 类和结构体采用大驼峰命名法，例如 GraphNode、StudentInfo。
3. 常量采用全大写字母，单词之间用下划线连接**，例如 MAX_SIZE、DEFAULT_VALUE。
4. 文件名采用小写字母和下划线，例如 binary_search.cpp、merge_sort.cpp。
5. 算法中常见的局部变量可以使用简短名称，例如循环下标 i、j，元素数量 n。其他变量应尽量体现具体含义，同一作用域内避免使用容易混淆的名称。

二、缩进与排版

1. 统一使用 4 个空格缩进，不混用空格和 Tab。
2. 左大括号放在语句所在行的末尾，右大括号单独占一行。
3. if、for、while 后保留一个空格；运算符两侧、逗号后保留适当空格。
4. 条件和循环语句即使只有一条执行语句，也使用大括号。
5. 不同功能的代码块之间用空行分隔，避免连续堆积代码。
6. 一行代码尽量不超过 100 个字符，过长的表达式在合适的位置换行。

例如：
int calculateSum(const std::vector& numbers) {
int total = 0;
for (int number : numbers) {
total += number;
}
return total;
}

三、注释规范

1. 注释主要说明算法思路、关键步骤和容易出错的地方，避免逐行重复代码的含义。
2. 较复杂的函数应说明功能，必要时补充参数含义、返回值和适用条件。
3. 对特殊边界处理、下标转换等操作，说明这样处理的原因。
4. 修改代码时同步更新相关注释，避免注释与实际逻辑不一致。
5. 提交前删除无用的调试信息和大段废弃代码，保持文件整洁。

四、函数与代码结构

1. 每个函数尽量完成一项明确的任务，避免把所有逻辑都写在 main 函数中。
2. main 函数主要负责输入、调用算法和输出结果。
3. 重复出现的逻辑在确有需要时提取为函数，简单代码不做多余封装。
4. 变量尽量在使用位置附近声明，并缩小作用范围，减少不必要的全局变量。
5. 只引入实际需要的头文件，保持依赖清楚。

五、数据类型与正确性

1. 使用变量前明确初始化，避免依赖未初始化的值。
2. 根据数据范围选择类型。涉及较大整数的求和、乘法时，注意使用 long long，并确保中间计算也不会溢出。
3. 访问数组或容器前确认下标范围，尤其注意首尾位置和空容器。
4. 对代码中具有具体含义的固定数值，优先使用命名常量，减少难以理解的“魔法数字”。
5. 根据题目要求选择数据结构，同时考虑时间复杂度和空间复杂度。

六、测试与调试
完成代码后，先检查题目样例，再根据算法特点补充测试：

• 最小规模、单个元素等边界情况；
• 重复元素、全相等元素等特殊情况；
• 已排序、逆序等可能影响算法表现的数据；
• 接近题目上限的数据规模和数值范围。
  出现错误时，先定位问题，再修改代码，避免没有依据地反复尝试。修复后重新运行相关测试，确认修改没有影响其他情况。

七、作业提交规范
提交前统一检查文件名、格式和输出要求，清理调试输出，确认最终版本能够编译并通过测试。对于关键算法，我会确保自己能够解释实现思路，以及时间和空间复杂度。
本学期我会在每次作业中持续遵守这套规范，逐步养成先理清思路、再编写代码、最后检查验证的习惯。