第一次结对做业代码复审

1、代码功能及地址

功能：足球比赛两队控球时间比例显示牌

地址：https://github.com/1297340141/LED-/blob/master/1.c

2、复审结果

功能模块名称	足球比赛两队控球时间比例显示牌
审查人	刘家兴	审查日期	219.04.23
代码名称	1.c	代码做者	张纯鹤
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	不合理
	头文件和定义文件的目录结构是否合理？	无目录结构
无目录	版权和版本声明是否完整？	无声明
重要	头文件是否使用了 ifndef/define/endif 预处理块?	是
	头文件中是否只存放“声明”而不存放“定义”	是
程序的版式
重要性	审查项	结论
	空行是否得体？	否
	代码行内的空格是否得体？	否
	长行拆分是否得体？	无长行
	“{” 和 “}” 是否各占一行而且对齐于同一列？	否
重要	一行代码是否只作一件事？如只定义一个变量，只写一条语句。	否
重要	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	是
重要	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰而且必要？	是
重要	注释是否有错误或者可能致使误解？	否
重要	类结构的public, protected, private顺序是否在全部的程序中保持一致？	无类结构
命名规则
重要性	审查项	结论
重要	命名规则是否与所采用的操做系统或开发工具的风格保持一致？	否
	标识符是否直观且能够拼读？	否
	标识符的长度应当符合“min-length && max-information”原则？	否
重要	程序中是否出现相同的局部变量和所有变量？	否
	类名、函数名、变量和参数、常量的书写格式是否遵循必定的规则？	否
	静态变量、全局变量、类的成员变量是否加前缀？	否
表达式与基本语句
重要性	审查项	结论
重要	若是代码行中的运算符比较多，是否已经用括号清楚地肯定表达式的操做顺序？	是
	是否编写太复杂或者多用途的复合表达式？	否
重要	是否将复合表达式与“真正的数学表达式”混淆？	否
重要	是否用隐含错误的方式写if语句? 例如
	（1）将布尔变量直接与TRUE、FALSE或者一、0进行比较。	无
	（2）将浮点变量用“==”或“！=”与任何数字比较。	无
	（3）将指针变量用“==”或“！=”与NULL比较。	否
	若是循环体内存在逻辑判断，而且循环次数很大，是否已经将逻辑判 断移到循环体的外面？	是
重要	Case语句的结尾是否忘了加break？	否
重要	是否忘记写switch的default分支？	是
重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	无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的语句是否正确无误？	无
C++ 函数的高级特性
重要性	审查项	结论
	重载函数是否有二义性？	无
重要	是否混淆了成员函数的重载、覆盖与隐藏？	无
	运算符的重载是否符合制定的编程规范？	无
	是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。	无
重要	是否用内联函数取代了宏代码？	无
类的构造函数、析构函数和赋值函数
重要性	审查项	结论
重要	是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数：
	（1）缺省的无参数构造函数；	无
	（2）缺省的拷贝构造函数；	无
	（3）缺省的析构函数；	无
	（4）缺省的赋值函数。	无
重要	构造函数中是否遗漏了某些初始化工做？	无
重要	是否正确地使用构造函数的初始化表？	无
重要	析构函数中是否遗漏了某些清除工做？	无
	是否错写、错用了拷贝构造函数和赋值函数？	无
重要	赋值函数通常分四个步骤：
	（1）检查自赋值；	无
	（2）释放原有内存资源；	无
	（3）分配新的内存资源，并复制内容；	无
	（4）返回 *this。是否遗漏了重要步骤？	无
重要	是否正确地编写了派生类的构造函数、析构函数、赋值函数？	无
	注意事项：
	（1）派生类不可能继承基类的构造函数、析构函数、赋值函数。	无
	（2）派生类的构造函数应在其初始化表里调用基类的构造函数。	无
	（3）基类与派生类的析构函数应该为虚（即加virtual关键字）。	无
	（4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员从新赋值	无
类的高级特性
重要性	审查项	结论
重要	是否违背了继承和组合的规则？
	（1）若在逻辑上B是A的“一种”，而且A的全部功能和属性对B而言都有意义，则容许B继承A的功能和属性。	无
	（2）若在逻辑上A是B的“一部分”（a part of），则不容许B从A派生，而是要用A和其它东西组合出B。	无
其它常见问题
重要性	审查项	结论
重要	数据类型问题：
	（１）变量的数据类型有错误吗？	没有
	（２）存在不一样数据类型的赋值吗？	不存在
	（３）存在不一样数据类型的比较吗？	不存在
重要	变量值问题：
	（１）变量的初始化或缺省值有错误吗？	无
	（２）变量发生上溢或下溢吗？	无
	（３）变量的精度够吗？	无
重要	逻辑判断问题：
	（１）因为精度缘由致使比较无效吗？	无
	（２）表达式中的优先级有误吗？	没有
	（３）逻辑判断结果颠倒吗？	否
重要	循环问题：
	（１）循环终止条件不正确吗？	否
	（２）没法正常终止（死循环）吗？	无
	（３）错误地修改循环变量吗？	无
	（４）存在偏差累积吗？	无
重要	错误处理问题：
	（１）忘记进行错误处理吗？	无
	（２）错误处理程序块一直没有机会被运行？	无
	（３）错误处理程序块自己就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。	无
	（４）错误处理程序块是“马后炮”吗？如在被它被调用以前软件已经出错。	无
重要	文件I/O问题：
	（１）对不存在的或者错误的文件进行操做吗？	无
	（２）文件以不正确的方式打开吗？	无
	（３）文件结束判断不正确吗？	无
	（４）没有正确地关闭文件吗?	无

3、总结

1.对代码的一些优势感悟

• a.符合C51编程习惯，在代码开头从新定义声明数据类型。

• b.思路清晰，将设计拆分开为定时器、计算、送显等几部分，简化设计，易于实现。

• c.函数功能简单明了，每一个函数只干一件事。

• d.代码中有多个按键判断，但每次按键判断都加了延时消抖二次判断，在数码管送显后加了消隐，很细心的设计。

2.针对复审中一些问题的意见

a.命名与注释

在进行变量命名时应避免简单字符以及拼音，尽可能采用符合规范的命名方式，找到本身喜欢的一种命名规范并长期坚持；在给函数和类命名时也应该明确函数的功能，并采用统一的命名规范；添加注释时应在重要的点或者难以明了的地方添加，代码更改，注释也要同时更改，不要引发对代码的误解。

b.空行问题

在复审过程当中发现存在不少无心义的空行，而且无规律，严重下降了代码的美观性与可读性。在重要的函数、方法、类、逻辑快之间添加将会提升代码的可读性。

c.缩进问题

代码中存在着许多不合理的缩进，例以下图：

而且同一行定义太多的变量，也没有初始化，应该“一行只干一件事”。

d.其它问题

代码中惟一一处switch-case语句段最后并未携带default语句。

代码中存在两种花括号对齐方式，应采起一种规范，一行一个，成对出现，在同一列上对齐。

存在功能相同或相近的函数应使用一个代替，如代码中的两个延时函数。

以上仅仅是本人照看代码审查表提出的一些的问题，可能不全面也可能有失偏颇，仅供参考使用。

3.复审过程对本身的启示

以上提出来了许多问题，同时自己也不可避免的带有这些问题，因此代码复审的过程不只仅是查看他人，更是对本身代码规范的一次从新审查。但愿在之后的结对任务中互相帮助，共同进步。