1. Informação Pública
| Informações do blog | Universidade de Aeronáutica e Astronáutica de Shenyang, Escola de Engenharia de Computação 2020 Engenharia de Software |
|---|---|
| Requisitos de trabalho | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| Objetivos do curso | Familiarizado com o processo de desenvolvimento de um software de "alta qualidade" |
| Objetivo da lição de casa | Familiarizado com as especificações de código e a revisão mútua em pares |
Segundo, o código
Descrição do código Use a linguagem C para realizar o jogo pequeno 2048
3. Resultados da revisão
| Nome do módulo de função | Estabelecimento de gráfico direcionado e operações básicas | ||
|---|---|---|---|
| Revisor | Li Boyuan | Data da revisão | 2020.4.17 |
| Nome do código | 2048 mini game | Autor do código | Zhang Hengwei |
| Estrutura de arquivo | |||
| Importância | Rever item | Conclusão | |
| Os nomes dos arquivos de cabeçalho e de definição são razoáveis? | Sim | ||
| A estrutura de diretórios dos arquivos de cabeçalho e dos arquivos de definição é razoável? | Sim | ||
| As declarações de direitos autorais e versão estão completas? | Nenhuma | ||
| Importante | O arquivo de cabeçalho usa blocos de pré-processamento ifndef / define / endif? | Sim | |
| Armazenar apenas "declaração", mas não "definição" no arquivo de cabeçalho | Sim | ||
| O formato do programa | |||
| Importância | Rever item | Conclusão | |
| A linha em branco é decente? | Sim | ||
| Os espaços nas linhas de código são decentes? | Sim | ||
| A linha longa é decente? | Nenhuma | ||
| "{" E "}" ocupam uma linha cada e estão alinhados na mesma coluna? | Sim | ||
| Importante | Uma linha de código faz apenas uma coisa? Se apenas uma variável for definida, escreva apenas uma instrução. | Não | |
| Importante | Se, por enquanto, do e outras instruções estiverem em sua própria linha, "{}" deverá ser adicionado, não importa quantas instruções sejam executadas. | Não | |
| Importante | Ao definir uma variável (ou parâmetro), os modificadores são * e & próximos ao nome da variável? Os comentários são claros e necessários? | Sim | |
| Importante | Há algum erro nos comentários ou pode causar mal-entendidos? | Não | |
| Importante | A ordem pública, protegida e privada da estrutura de classes é consistente em todos os programas? | Nenhuma | |
| Convenção de nomenclatura | |||
| Importância | Rever item | Conclusão | |
| Importante | A convenção de nomenclatura é consistente com o estilo do sistema operacional ou da ferramenta de desenvolvimento usada? | Sim | |
| O identificador é intuitivo e ortográfico? | Sim | ||
| O comprimento do identificador deve estar de acordo com o princípio "min-length && max-information"? | Sim | ||
| Importante | As mesmas variáveis locais e todas as variáveis aparecem no programa? | Não | |
| Os nomes de classes, nomes de funções, variáveis e parâmetros e constantes seguem certas regras? | Sim | ||
| As variáveis estáticas, variáveis globais e variáveis de membro da classe são prefixadas? | Sim | ||
| Expressões e frases básicas | |||
| Importância | Rever item | Conclusão | |
| Importante | Se houver muitos operadores na linha de código, os parênteses foram usados para determinar claramente a ordem das operações da expressão? | Sim | |
| Você escreve expressões compostas muito complexas ou versáteis? | Não | ||
| Importante | Expressões compostas são confundidas com "expressões matemáticas reais"? | Não | |
| Importante | A instrução if está escrita em um erro implícito? Por exemplo | ||
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？ | 否 | ||
| 重要 | Case语句的结尾是否忘了加break？ | 无 | |
| 重要 | 是否忘记写switch的default分支？ | 无 | |
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无 | |
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 否 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 | |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | 无 | ||
| 生存期内是常量，而对于整个类而言却是可变的。 | 无 | ||
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 否 | ||
| 参数命名、顺序是否合理？ | 否 | ||
| 参数的个数是否太多？ | 是 | ||
| 是否使用类型和数目不确定的参数？ | 否 | ||
| 是否省略了函数返回值的类型？ | 否 | ||
| 函数名字与返回值类型在语义上是否冲突？ | |||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | |
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 否 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | ||
| 内存管理 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 无 | |
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 否 | |
| 重要 | 数组或指针的下标是否越界？ | 否 | |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 无 | |
| 重要 | 是否有效地处理了“内存耗尽”问题？ | 无 | |
| 重要 | 是否修改“指向常量的指针”的内容？ | 无 | |
| 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 无 | |
| 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 无 | |
| 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 无 | |
| 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 无 | |
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 否 | ||
| （２）存在不同数据类型的赋值吗？ | 否 | ||
| （３）存在不同数据类型的比较吗？ | 否 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 否 | ||
| （２）变量发生上溢或下溢吗？ | 否 | ||
| （３）变量的精度够吗？ | 否 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 否 | ||
| （２）表达式中的优先级有误吗？ | 否 | ||
| （３）逻辑判断结果颠倒吗？ | 否 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 否 | ||
| （２）无法正常终止（死循环）吗？ | 否 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 否 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 无 | ||
| （２）错误处理程序块一直没有机会被运行？ | 无 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 无 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 无 | ||
| 重要 | 文件I/O问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 无 | ||
| （２）文件以不正确的方式打开吗？ | 无 | ||
| （３）文件结束判断不正确吗？ | 无 | ||
| （４）没有正确地关闭文件吗? | 无 |
四、评价
下面分析一下代码优缺点：
优点如下：
- 代码逻辑块分块清晰，各个方法之间牵连较小，易于维护
- 注释合理规范，做到该注释的地方就注释，而没有多余无意义的注释
- 函数命名十分规整，完整表示函数作用
- 代码编写基本符合规范
但是，其项目也暴露出了一些问题。
其缺点如下：
- 所有的代码混在一个.c文件中，没有进行分文件编写代码，再进行调用
- 没有做到一行代码做一件事，有些函数中存在将两语句写在一行的情况
- 很多变量使用单字母进行表示，变量可读性较差