算法第一章作业
阅相关 C++ 编码规范资料后,结合本学期算法课程的编程作业,我将从命名、代码排版、注释、代码逻辑、编译提交这几个方面遵守如下编码规范:
一、命名规范
- 普通变量、自定义函数采用小驼峰命名,名字尽量见名知意,使用英文,尽量不使用拼音和无意义缩写,例如
maxValue、dpTable。循环计数器允许简写i、j、k。 - 结构体、类使用**大驼峰命名,例如
MatrixChain。 - 常量、数组最大长度定义为全部大写,单词下划线隔开,例如
MAX_N、INF。 - 尽量避免意义模糊的单字母变量,除循环下标之外。
二、排版与格式规范
- 缩进统一使用4 个空格,不使用 Tab,防止不同编译器下排版错乱。
- 运算符两边加上空格,逗号后面添加空格,提升阅读体验。
if、for、while等控制语句,**哪怕只有一行执行代码,也要带上大括号,防止后续增加代码时出现逻辑错误。- 功能不同的代码块之间空一行分隔,例如变量定义、循环、输出代码之间,让代码层次分明。
- 控制单行代码长度,语句太长时进行换行,不要写一整行超长代码。
- 一条语句只写在一行,不在同一行写多个逻辑语句。
三、注释规范
注释的目的是解释思路、原因、边界条件,不要重复复述代码已经写出来的内容。
- 动态规划题目重点注释 dp 数组的含义、状态转移思路;
- 对特殊边界、容易踩坑的地方写注释;简单直白的代码不需要多余注释;
- 注释写在代码上方,不要大量行尾堆砌注释;
- 对于路径记录、分割点等关键变量简单说明用途。
四、代码编写逻辑规范
- 变量随用随定义,不要在函数开头一次性全部定义。
- 尽量消除魔法数字,固定数值优先用常量定义。
- 合理选择数据类型,遇到乘法、大数运算,使用
long long防止整数溢出(例如最大 k 乘积题目)。 - 写课程作业时,优先兼容 C++98 标准,尽量不用 C++11 新语法(例如范围 for 循环),避免 Dev‑C++ 等旧编译器报编译错误。
- 减少过深的循环、if 嵌套,逻辑尽量简洁清晰;一个函数尽量只完成一项功能。
- 重视边界情况,考虑输入极值、数组下标边界,避免数组越界。
五、编译与提交规范
- 提交代码前进行编译,消除编译警告。
- 只保留程序真正需要的头文件,删掉调试输出语句、无用变量、废弃代码。
- 严格对照题目要求,保证输入输出格式完全匹配,换行、分隔符号和样例保持一致。
- 写完代码自己读一遍,保证自己可以看懂自己写的算法逻辑。

浙公网安备 33010602011771号