结对作业第一次

1.所审查代码信息

（1）结对伙伴：周成芸

（2）项目代码地址：<a style="color:purple;text-decoration:none;"href=" https://dev.tencent.com/u/zhoucysw/p/8051DigitalThermometer.cpp/git/commit/f2d4febaa8cda0025106922eee3c550330a10f6c">点我进入coding

（3）项目代码功能：用数字温度计采集温度，读取数据并显示。

2.审查代码细节汇总

参照<a style="color:purple;text-decoration:none;"href=" https://blog.csdn.net/wenrenhua08/article/details/39591273">C/C++代码审查表审查汇总如下

 

功能模块名称	用数字温度计采集温度
审查人	肖乃俊	审查日期	2019/4/23
代码名称	用数字温度计采集温度，读取数据并显示	代码作者	周成芸
文件结构
重要性	审查项	结论
	头文件和定义文件的名称是否合理？	合理
	头文件和定义文件的目录结构是否合理？	是
	版权和版本声明是否完整？	否
重要	头文件是否使用了 ifndef/define/endif 预处理块?	是
	头文件中是否只存放“声明”而不存放“定义”	否
程序的版式
重要性	审查项	结论
	空行是否得体？	是。不同的功能模块之间都有空行，模块结构清晰明了
	代码行内的空格是否得体？	是
	长行拆分是否得体？	是。此代码没有需要拆分的长行
	“{” 和 “}” 是否各占一行并且对齐于同一列？	是
重要	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	是
重要	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	否
重要	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？	是
重要	注释是否有错误或者可能导致误解？	否
重要	类结构的public, protected, private顺序是否在所有的程序中保持一致？	否。全部用C语言实现，未涉及类结构<
/td>
命名规则
重要性	审查项	结论
重要	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是
	标识符是否直观且可以拼读？	是。用英语单词命名，直观简单
	标识符的长度应当符合“min-length && max-information”原则？	是
重要	程序中是否出现相同的局部变量和全部变量？	是
	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	是。函数名一律用英文单词加"_"f符号拼接，参数用单词的小写字母
	静态变量、全局变量、类的成员变量是否加前缀？	否
表达式与基本语句
重要性	审查项	结论
重要	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	否
	是否编写太复杂或者多用途的复合表达式？	是
重要	是否将复合表达式与“真正的数学表达式”混淆？	否
重要	是否用隐含错误的方式写if语句? 例如	否。全篇只用了两个if语句，且结构简单，作用完整
	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	否。不涉及
	（2）将浮点变量用“==”或“！=”与任何数字比较。	是
	（3）将指针变量用“==”或“！=”与NULL比较。	否。不涉及
	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判
	断移到循环体的外面？	否。不涉及
重要	Case语句的结尾是否忘了加break？	否。无case语句
重要	是否忘记写switch的default分支？	否。无switch语句
重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	否。不涉及这些语句
常量
重要性	审查项	结论
	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是。全局变量为含义直观的常量
	在C++ 程序中，是否用const常量取代宏常量？	否
重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	是
	是否误解了类中的const数据成员？因为const数据成员只在某个对象	否。不涉及类
	生存期内是常量，而对于整个类而言却是可变的。	否。不涉及类
函数设计
重要性	审查项	结论
	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	否
	参数命名、顺序是否合理？	是
	参数的个数是否太多？	否。至多一个
	是否使用类型和数目不确定的参数？	否
	是否省略了函数返回值的类型？	否
	函数名字与返回值类型在语义上是否冲突？	否
重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	否。无错误标志返回
重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	否
重要	使用滥用了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）代码功能结构清晰明了，定义与功能函数之间分块，函数与函数之间分行，函数内部不同的功能之间分行且缩进合理，整体布局整齐有序。 （2）常量定义、函数名以功能命名，便于理解与运用。 （3）运算操作选用相对简洁的语句，操作熟练，看上去容易理解，可读性强。 （4）各个子功能模块功能明确，主函数调用条件明确，不赘余。 （5）子函数以“_”连接单词表明功能特点，使子函数功能明了。 ##代码缺点： （1）主函数中没有return，降低了代码的稳定性。 （2）各个子函数内部遵循的缩进量不一致。 （3）判断句中，只有一句执行语句就不加“{}”。 （4）子函数中，没有考虑错误返回。全篇没有容错考虑。 （5）函数命名方法不一致，有rd_temperature_f(void)、Read_DS18B20(void)，首字母有大写有小写。 ###总结：通过这次审查同伴代码，我学习到了她写代码的组织整齐结构清晰和运算操作简洁高效的优点，她的代码可读性非常强，尤其体现在格式规则布局整齐。一直以为自己在代码中加入的简便操作是很机智的了，果然，山的那边还有更高的山。这次审查中，我看到了同伴的不足，也看到了她的严谨，但更让我关注的是她对编程的熟练程度，同一个操作目的，我最少需要三行才能实现，而熟练的人只用了一行，这不仅仅需要有对编程练习的时间深度，还要掌握一定的对编程知识的广度。审查过程结束，我发现我们都没有对存储空间、运行时间、内存溢出、数组越界、对内存空间申请和释放等等问题的考虑。这些都是我和我的同伴应该改进的地方。