第四次博客作业-结对项目
任务1：（5分）
在 学习通上注明结对的成员对 格式： 班级姓名-----班级姓名
1班李双辉 - 3班刘厚飞
任务2：（95分）
结对的成员共同完成本次作业，撰写博客并将结对项目的程序发布到github上
博客的内容安排如下：
（1）提供你的结对成员的博客链接地址（5分）
https://www.cnblogs.com/lishuanghui/p/11705107.html
（2）结对成员对四则运算项目进行代码互审，并给出代码审查结果表
刘厚飞的代码审查表（由李双辉完成）（10分）
|
类别 |
重要性 |
激活(Y or N) |
级别 |
检查项 |
|
命名
|
重要 |
N |
20 |
命名规则是否与所采用的规范保持一致？ |
| N |
20 |
是否遵循了最小长度最多信息原则？ |
||
|
重要 |
N |
50 |
has/can/is前缀的函数是否返回布尔型？ |
|
|
注释
|
重要 |
N |
10 |
|
|
重要 |
Y |
10 |
复杂的分支流程是否已经被注释？ |
|
| N |
10 |
距离较远的}是否已经被注释？ |
||
| N |
10 |
非通用变量是否全部被注释？ |
||
|
重要 |
N |
50 |
函数是否已经有文档注释？（功能、输入、返回及其他可选） |
|
| Y |
10 |
特殊用法是否被注释？ |
||
| 声明、空白、缩进
|
Y |
20 |
每行是否只声明了一个变量？（特别是那些可能出错的类型） |
|
|
重要 |
N |
40 |
变量是否已经在定义的同时初始化？ |
|
|
重要 |
N |
40 |
类属性是否都执行了初始化？ |
|
| Y |
20 |
代码段落是否被合适地以空行分隔？ |
||
| N |
20 |
是否合理地使用了空格使程序更清晰？ |
||
| Y |
20 |
代码行长度是否在要求之内？ |
||
| N |
20 |
折行是否恰当？ |
||
| 语句/功能分布/规模
|
Y |
20 |
包含复合语句的{}是否成对出现并符合规范？ |
|
| N |
20 |
是否给单个的循环、条件语句也加了{}？ |
||
| Y |
20 |
if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？ |
||
| Y |
40 |
单个变量是否只做单个用途？ |
||
|
重要 |
Y |
20 |
单行是否只有单个功能？（不要使用；进行多行合并） |
|
|
重要 |
Y |
40 |
单个函数是否执行了单个功能并与其命名相符？ |
|
| Y |
20 |
操作符＋＋和— —操作符的应用是否复合规范？ |
||
|
规模
|
重要 |
N |
20 |
单个函数不超过规定行数？ |
|
重要 |
Y |
100 |
缩进层数是否不超过规定？ |
|
|
重要 |
N |
100 |
是否已经消除了所有警告？ |
|
|
重要 |
Y |
40 |
常数变量是否声明为final？ |
|
|
重要 |
N |
80 |
对象使用前是否进行了检查？ |
|
|
重要 |
N |
80 |
局部对象变量使用后是否被复位为NULL？ |
|
|
重要 |
Y |
70 |
对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。 |
|
|
重要 |
Y |
20 |
是否确认没有同名变量局部重复定义问题? |
|
| N |
20 |
程序中是否只使用了简单的表达式？ |
||
|
重要 |
Y |
20 |
是否已经用（）使操作符优先级明确化？ |
|
|
重要 |
N |
20 |
所有判断是否都使用了（常量==变量）的形式？ |
|
| N |
80 |
是否消除了流程悬挂？ |
||
|
重要 |
Y |
80 |
是否每个if-else if-else语句都有最后一个else以确保处理了全集？ |
|
|
重要 |
N |
80 |
是否每个switch-case语句都有最后一个default以确保处理了全集？ |
|
| Y |
80 |
for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX） |
||
|
重要 |
N |
40 |
XML标记书写是否完整，字符串的拼写是否正确? |
|
| N |
40 |
对于流操作代码的异常捕获是否有finally操作以关闭流对象? |
||
| N |
20 |
退出代码段时是否对临时对象做了释放处理? |
||
|
重要 |
N |
40 |
对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断） |
|
|
可靠性（函数）
|
重要 |
N |
60 |
入口对象是否都被进行了判断不为空？ |
|
重要 |
Y |
60 |
入口数据的合法范围是否都被进行了判断？(尤其是数组) |
|
|
重要 |
N |
20 |
是否对有异常抛出的方法都执行了try...catch保护？ |
|
|
重要 |
Y |
80 |
是否函数的所有分支都有返回值？ |
|
|
重要 |
N |
50 |
int的返回值是否合理？（负值为失败，非负值成功） |
|
| N |
20 |
对于反复进行了int返回值判断是否定义了函数来处理？ |
||
| N |
60 |
关键代码是否做了捕获异常处理? |
||
|
重要 |
N |
60 |
是否确保函数返回CORBA对象的任何一个属性都不能为null? |
|
|
重要 |
Y |
60 |
是否对方法返回值对象做了null检查，该返回值定义时是否被初始化? |
|
|
重要 |
N |
60 |
是否对同步对象的遍历访问做了代码同步? |
|
|
重要 |
Y |
80 |
是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？ |
|
|
重要 |
Y |
60 |
线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出? |
|
| N |
20 |
原子操作代码异常中断，使用的相关外部变量是否恢复先前状态? |
||
|
重要 |
N |
100 |
函数对错误的处理是恰当的？ |
|
|
可维护性 |
重要 |
N |
100 |
实现代码中是否消除了直接常量？（用于计数起点的简单常数例外） |
| Y |
20 |
是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )） |
||
| N |
20 |
是否每个return前都要有日志记录? |
||
| N |
20 |
是否有冗余判断语句？（如：if (b) return true; else return false;） |
||
| N |
20 |
是否把方法中的重复代码抽象成私有函数? |
李双辉的代码审查表（由刘厚飞完成）（10分）
|
类别 |
重要性 |
激活(Y or N) |
级别 |
检查项 |
|
命名 |
重要 |
N |
20 |
命名规则是否与所采用的规范保持一致？ |
| N |
20 |
是否遵循了最小长度最多信息原则？ |
||
|
重要 |
N |
50 |
has/can/is前缀的函数是否返回布尔型？ |
|
|
注释
|
重要 |
N |
10 |
注释是否较清晰且必要？ |
|
重要 |
Y |
10 |
复杂的分支流程是否已经被注释？ |
|
| N |
10 |
距离较远的}是否已经被注释？ |
||
| N |
10 |
非通用变量是否全部被注释？ |
||
|
重要 |
N |
50 |
函数是否已经有文档注释？（功能、输入、返回及其他可选） |
|
| Y |
10 |
特殊用法是否被注释？ |
||
| 声明、空白、缩进
|
Y |
20 |
每行是否只声明了一个变量？（特别是那些可能出错的类型） |
|
|
重要 |
N |
40 |
变量是否已经在定义的同时初始化？ |
|
|
重要 |
N |
40 |
类属性是否都执行了初始化？ |
|
| Y |
20 |
代码段落是否被合适地以空行分隔？ |
||
| N |
20 |
是否合理地使用了空格使程序更清晰？ |
||
| Y |
20 |
代码行长度是否在要求之内？ |
||
| N |
20 |
折行是否恰当？ |
||
| 语句/功能分布/规模 | Y |
20 |
包含复合语句的{}是否成对出现并符合规范？ |
|
| N |
20 |
是否给单个的循环、条件语句也加了{}？ |
||
| Y |
20 |
if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？ |
||
| Y |
40 |
单个变量是否只做单个用途？ |
||
|
重要 |
Y |
20 |
单行是否只有单个功能？（不要使用；进行多行合并） |
|
|
重要 |
Y |
40 |
单个函数是否执行了单个功能并与其命名相符？ |
|
| Y |
20 |
操作符＋＋和— —操作符的应用是否复合规范？ |
||
|
规模
|
重要 |
N |
20 |
单个函数不超过规定行数？ |
|
重要 |
Y |
100 |
缩进层数是否不超过规定？ |
|
|
重要 |
N |
100 |
是否已经消除了所有警告？ |
|
|
重要 |
Y |
40 |
常数变量是否声明为final？ |
|
|
重要 |
N |
80 |
对象使用前是否进行了检查？ |
|
|
重要 |
N |
80 |
局部对象变量使用后是否被复位为NULL？ |
|
|
重要 |
Y |
70 |
对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。 |
|
|
重要 |
Y |
20 |
是否确认没有同名变量局部重复定义问题? |
|
| N |
20 |
程序中是否只使用了简单的表达式？ |
||
|
重要 |
Y |
20 |
是否已经用（）使操作符优先级明确化？ |
|
|
重要 |
N |
20 |
所有判断是否都使用了（常量==变量）的形式？ |
|
| N |
80 |
是否消除了流程悬挂？ |
||
|
重要 |
Y |
80 |
是否每个if-else if-else语句都有最后一个else以确保处理了全集？ |
|
|
重要 |
N |
80 |
是否每个switch-case语句都有最后一个default以确保处理了全集？ |
|
| Y |
80 |
for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX） |
||
|
重要 |
N |
40 |
XML标记书写是否完整，字符串的拼写是否正确? |
|
| N |
40 |
对于流操作代码的异常捕获是否有finally操作以关闭流对象? |
||
| N |
20 |
退出代码段时是否对临时对象做了释放处理? |
||
|
重要 |
N |
40 |
对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断） |
|
|
可靠性（函数）
|
重要 |
N |
60 |
入口对象是否都被进行了判断不为空？ |
|
重要 |
Y |
60 |
入口数据的合法范围是否都被进行了判断？(尤其是数组) |
|
|
重要 |
N |
20 |
是否对有异常抛出的方法都执行了try...catch保护？ |
|
|
重要 |
Y |
80 |
是否函数的所有分支都有返回值？ |
|
|
重要 |
N |
50 |
int的返回值是否合理？（负值为失败，非负值成功） |
|
| N |
20 |
对于反复进行了int返回值判断是否定义了函数来处理？ |
||
| N |
60 |
关键代码是否做了捕获异常处理? |
||
|
重要 |
N |
60 |
是否确保函数返回CORBA对象的任何一个属性都不能为null? |
|
|
重要 |
Y |
60 |
是否对方法返回值对象做了null检查，该返回值定义时是否被初始化? |
|
|
重要 |
N |
60 |
是否对同步对象的遍历访问做了代码同步? |
|
|
重要 |
Y |
80 |
是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？ |
|
|
重要 |
Y |
60 |
线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出? |
|
| N |
20 |
原子操作代码异常中断，使用的相关外部变量是否恢复先前状态? |
||
|
重要 |
N |
100 |
函数对错误的处理是恰当的？ |
|
|
可维护性 |
重要 |
N |
100 |
实现代码中是否消除了直接常量？（用于计数起点的简单常数例外） |
| Y |
20 |
是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )） |
||
| N |
20 |
是否每个return前都要有日志记录? |
||
| N |
20 |
是否有冗余判断语句？（如：if (b) return true; else return false;） |
||
| N |
20 |
是否把方法中的重复代码抽象成私有函数? |
（3）选取其中一个成员的项目为基础，进行结对编程。结对项目撰写的博客要求：（30分）
（a）结合课堂讲授内容，制订一份2人共同遵守的代码编写基本规范（至少包括注释规范与变量命名规范）。
| 源代码文件以文件内容中的最顶层的Java类命名，而且大小写敏感，文件扩展名为 .java，同时，文件的编码格式统一为UTF-8 |
| 类的命名遵循大驼峰命名法UpperCamelCase，而方法名和变量名的命名遵循小驼峰命名法lowerCamelCase。常量名使用大写字母表示，单词之间以下划线分隔.jsp的文件名全部小写 |
| 一个程序文件最好不要超过２０００行 |
| 不用的代码和引用删除 |
| 请合理运用空行。空行可以用来隔开相对独立的代码块，有利于阅读和理解 |
| 为不容易理解类变量注释。注释代码段，注释逻辑选择 |
| 对成员方法,不要轻易采用public的成员变量。主要的修饰符有public, private, protected。避免过多的参数列表，尽量控制在５个以内 |
| 原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在","处或运算符处，换行后最好以运算符打头 |
| 为避免编程时遇到麻烦，请保证在自己类路径指到的任何地方，每个名字都仅对应一个类。否则，编译器可能先找到同名的另一个类，并报告出错消息 |
| 字符串不应该重复，如果多次用到同一字符串，建议将该字符串定义为字符串常量，再引用 |
（b）描述结对编程的感受。
我对结对编程最大的感受：
1.起到督促的作用
这主要是因为有的时候如果一个人编程，可能会出现懈怠的情绪，而两个人共同编程会互相激励，起到促进作用
2.更高效的进行整体架构设计。
在个人编程时，有时会出现对整体架构把握不清的情况，这时如果能跟队友共同讨论分析，会大大加快理解以及设计的速度。
3.对具体函数细节有更好的组织以及优化
在一个人敲代码时，另一个人可以反思这部分代码有什么问题，哪里可以进行优化，与其他部分的关系是什么，下一步应该如何进行处理。这些都能够使代码质量得到极大的提升。
4.更高效的debug
有的时候，要找出自己写的bug是一件非常困难的事情。但是如果有同伴在用一个不同的视角一起寻找问题，可能就能很快地找到一些不易发现的bug。
5.互相学习，共同提高
在结对编程中，可以发现队友在编程中的很多好习惯以及心得，如果能够吸收这些东西为己用，便能够显著提高自己的编程水平。
（c）结对场景照片
4）结对项目编程要求：（40分）
对结对项目首先完成代码规范和设计规范的修改，其次完成项目增加的需求，最后将完成的项目提交到github上，给出github的连接地址，可以给出简单的设计说明。
增加的需求：
（a）考虑数据异常处理问题，如在输入题目生成范围的数据时，输入了“abc“等字符数据，程序如何处理。
（b）增大算式生成数的范围（如整数存不下的数），程序如何处理。
项目的GitHub地址：https://github.com/liuhf-jlu/CCUT_SE_SiZeAlgorithm.git
设计说明：
本项目遵循着面向对象的开发思想，进行了模块化设计，及不同的模块实现不同的功能，这样做可以降低程序的耦合度，减少依赖。
软件架构采用了分层模式
此模式用于可分解为子任务的结构化程序，每个子任务都位于特定的抽象层级，每一层都为上一层提供服务。一般信息系统最常见的4个层次如下。
表示层(也称为UI层)
应用层(也称为服务层)
业务逻辑层(也称为领域层)
数据访问层(也称为持久层)
