除非必要，我拒绝在Markdown里使用HTML
审查基本信息
代码审查（Code Investigation）
文件结构（File System）
| 审查项 |
重要 |
评估 |
备注 |
| 头文件和定义文件的名称是否合理？ |
× |
- |
无自定义头文件 |
| 头文件和定义文件的目录结构是否合理？ |
× |
- |
同上 |
| 版权和版本声明是否完整？ |
× |
- |
此代码用于课程设计，没有重视版本控制 |
头文件是否使用了 ifndef/define/endif 预处理块?（或头文件保护符#pragma once） |
√ |
- |
无自定义头文件 |
| 头文件中是否只存放“声明”而不存放“定义”？ |
× |
- |
同上 |
代码风格（Code Style）
| 审查项 |
重要 |
评估 |
备注 |
| 空行是否得体？ |
× |
× |
子程序彼此之间无空行，而相对应的一些本不当分开的语句中间存在不适当的空行 |
| 长行拆分是否得体？ |
× |
- |
运算符与运算元之间缺少合理的空格 |
{ 和 } 是否各占一行并且对齐于同一列？ |
× |
√ |
绝大部分做到了，但有少数位置被多缩进了一次 |
| 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 |
√ |
√ |
|
if、for、while、do等语句自占一行，不论执行语句多少都要加 {}。 |
√ |
× |
少数位置没有放置{} |
在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ |
√ |
√ |
|
| 注释是否有错误或者可能导致误解？ |
√ |
√ |
|
| 类结构的public, protected, private顺序是否在所有的程序中保持一致？ |
√ |
- |
程序中没有定义类 |
命名规范（Naming Convention）
| 审查项 |
重要 |
评估 |
备注 |
| 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ |
√ |
√ |
|
| 标识符是否直观且可以拼读？ |
× |
× |
有些标识符仅用一个字母 |
| 标识符的长度应当符合“min-length && max-information”原则？ |
× |
√ |
仅限于满足上一条的内容 |
| 程序中是否出现相同的局部变量和全部变量？ |
√ |
√ |
|
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ |
× |
√ |
|
| 静态变量、全局变量、类的成员变量是否加前缀？ |
× |
× |
|
表达式与基本语句 （Expressions & Statements）
| 审查项 |
重要 |
评估 |
备注 |
| 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ |
√ |
× |
|
| 是否编写太复杂或者多用途的复合表达式？ |
× |
× |
|
| 是否将复合表达式与“真正的数学表达式”混淆？ |
× |
× |
|
是否用隐含错误的方式写if语句? |
√ |
× |
|
case语句的结尾是否忘了加break？ |
√ |
- |
无switch-case语句 |
是否忘记写switch的default分支？ |
√ |
- |
同上 |
使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 |
√ |
- |
没使用goto |
常量（Constants）
| 审查项 |
重要 |
评估 |
备注 |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ |
× |
√ |
仅定义了一个宏常量 |
| 在C++ 程序中，是否用const常量取代宏常量？ |
× |
× |
|
| 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ |
√ |
- |
仅定义了一个宏常量 |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象生存期内是常量，而对于整个类而言却是可变的。 |
√ |
- |
没有定义const成员 |
函数（Functions）
| 审查项 |
重要 |
评估 |
备注 |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 |
× |
√ |
|
| 参数命名、顺序是否合理？ |
× |
√ |
|
| 参数的个数是否太多？ |
× |
√ |
|
| 是否使用类型和数目不确定的参数？ |
× |
√ |
|
| 是否省略了函数返回值的类型？ |
× |
× |
|
| 函数名字与返回值类型在语义上是否冲突？ |
× |
× |
|
| 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 |
× |
√ |
这些函数没有返回错误标志，正常值直接返回得出 |
在函数体的“入口处”，是否用assert对参数的有效性进行检查？ |
√ |
× |
没有使用assert |
滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 |
× |
√ |
同上 |
return语句是否返回指向“栈内存”的“指针”或者“引用”？ |
√ |
× |
|
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。 |
× |
× |
|
内存管理（Memory Management）
| 审查项 |
重要 |
评估 |
备注 |
| 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） |
√ |
- |
没有使用动态分配 |
| 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） |
√ |
- |
同上 |
| 数组或指针的下标是否越界？ |
√ |
× |
|
| 动态内存的申请与释放是否配对？（防止内存泄漏） |
√ |
- |
没有使用动态分配 |
| 是否有效地处理了“内存耗尽”问题？ |
√ |
- |
同上 |
| 是否修改“指向常量的指针”的内容？ |
√ |
- |
没有使用指向常量的指针 |
| 是否出现野指针？ |
√ |
× |
|
| 是否将malloc/free 和 new/delete 混淆使用？ |
√ |
- |
没有使用动态分配 |
| malloc语句是否正确无误？例如字节数是否正确？类型转换是否正确？ |
√ |
- |
同上 |
| 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ |
√ |
- |
同上 |
C++函数的高级特性 （Advanced Features）
| 审查项 |
重要 |
评估 |
备注 |
| 重载函数是否有二义性？ |
√ |
- |
没有用到函数重载 |
| 是否混淆了成员函数的重载、覆盖与隐藏？ |
√ |
- |
没有用到类 |
| 运算符的重载是否符合制定的编程规范？ |
√ |
- |
没有重载运算符 |
| 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 |
× |
- |
没有使用内联函数 |
| 是否用内联函数取代了宏代码？ |
√ |
- |
同上 |
类（Classes）
| 审查项 |
重要 |
评估 |
备注 |
| 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数 |
√ |
- |
没有使用类（或者说没有以类的方式使用struct） |
| 构造函数中是否遗漏了某些初始化工作？ |
√ |
- |
同上 |
| 是否正确地使用构造函数的初始化表？ |
√ |
- |
同上 |
| 析构函数中是否遗漏了某些清除工作？ |
√ |
- |
同上 |
| 是否错写、错用了拷贝构造函数和赋值函数？ |
√ |
- |
同上 |
| 是否违背了继承和组合的规则？ |
√ |
- |
同上 |
其它常见问题（Miscellaneous）
| 审查项 |
重要 |
评估 |
备注 |
| 变量的数据类型有错误吗？ |
√ |
× |
|
| 存在不同数据类型的赋值吗？ |
√ |
× |
|
| 存在不同数据类型的比较吗？ |
√ |
× |
|
| 变量的初始化或缺省值有错误吗？ |
√ |
× |
|
| 变量发生上溢或下溢吗？ |
√ |
× |
|
| 变量的精度够吗？ |
√ |
√ |
|
| 由于精度原因导致比较无效吗？ |
√ |
× |
|
| 表达式中的优先级有误吗？ |
√ |
× |
|
| 逻辑判断结果颠倒吗？ |
√ |
× |
|
| 循环终止条件不正确吗？ |
√ |
× |
|
| 无法正常终止（死循环）吗？ |
√ |
× |
|
| 存在误差累积吗？ |
√ |
× |
|
| 忘记进行错误处理吗？ |
√ |
√ |
代码中没有对错误情形做处理 |
| 错误处理程序块一直没有机会被运行？ |
√ |
- |
同上 |
| 错误处理程序块本身就有问题吗？如报告的错误与实际错误不一致，处理方式不正确等等 |
√ |
- |
同上 |
| 错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 |
√ |
- |
同上 |
| 对不存在的或者错误的文件进行操作吗？ |
√ |
× |
尽管测试文件实际上存在，但没有考虑此文件不存在的风险 |
| 文件以不正确的方式打开吗？ |
√ |
× |
|
| 文件结束判断不正确吗？ |
√ |
× |
|
| 没有正确地关闭文件吗? |
√ |
× |
|
评价（Assessment）
此代码意图使用文件输入的方式进行无向图的深度优先遍历(DFS Traverse)
优点（Pros）
- + 将各子功能分模块编写，而没有全部挤在
main函数中
- + 合理地使用了缩进（尽管个别位置的缩进存在一些问题），代码的可读性良好
- + 在关键点处备以合理的注释
缺点（Cons）
- - 命名不成规范，函数命名混杂着camelCase、PascalCase和snake_case，变量名中也混杂着ALLCAPS风格
- - 尽管没有都挤到main函数里，所有的功能全部都写在了同一文件下，当功能模块很多的时候会导致工作效率下降（绝大部分时间被鼠标滚轮吃掉了）
- - 使用了大量的全局变量，这对于程序的并发是有害的
- - 没有考虑异常的情形，例如文件不存在、文件内容错误（如边的数量输出负数）等，并且缺乏这些情形的提示和处理
- - 混合使用了
iostream和cstdio的标准及文件输入输出流
- - 缺乏对内存资源的充分利用和有效管理，直接使用了一个100×100的
int数组一了百了（约40KB），这同时导致了程序的不可扩展性（如果节点数远超过100？）
- - 作为C++程序直接使用了C语言的头文件（如
stdio.h）而没有使用C风格头文件（如cstdio）
- - 功能函数和功能性的结构体没有做到接口与实现相分离（头文件）
- - 程序设计很大程度上体现了面向过程的思想，但C++提倡的是面向对象，因此
Undigraph完全可以定义为一个类，诸如addVertex等操作可以作为其成员函数。
- - 行
for语句图省事没有放置{}
- - 缺乏封装，这导致用户可能无意识或有意识地使用到不该使用的中间函数
结论（Conclusion）
作为一个课程设计而言，这是一个写的还算不错的程序，因为实现了所需要的功能，并且代码算法清晰简洁，也具备了一些结构化的思想，但是作为一个项目而言，这个项目同时有很多潜在的不规范的地方，忽略了项目长远的可能性，是有待改进的。
