软件工程第三次作业

审查对象:1705班穆可鑫

代码功能:查找具有前缀和后缀的最大权重的单词


序号 重要性 审查项 结论
1 不重要 命名规则是否与所采用的规范保持一致?
2 不重要 是否遵循了最小长度最多信息原则?
3 重要 has/can/is前缀的函数是否返回布尔型?
4 不重要 注释是否较清晰且必要?
5 不重要 复杂的分支流程是否已经被注释?
6 不重要 距离较远的}是否已经被注释?
7 不重要 非通用变量是否全部被注释?
8 重要 函数是否已经有文档注释?(功能、输入、返回及其他可选)
9 不重要 特殊用法是否被注释?
10 不重要 每行是否只声明了一个变量?(特别是那些可能出错的类型)
11 重要 变量是否已经在定义的同时初始化?
12 重要 类属性是否都执行了初始化?
13 不重要 代码段落是否被合适地以空行分隔?
14 不重要 是否合理地使用了空格使程序更清晰?
15 不重要 代码行长度是否在要求之内?
16 不重要 折行是否恰当?
17 不重要 包含复合语句的{}是否成对出现并符合规范?
18 不重要 是否给单个的循环、条件语句也加了{}?
19 不重要 if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范?
20 不重要 单个变量是否只做单个用途?
21 重要 单行是否只有单个功能?(不要使用;进行多行合并)
22 重要 单个函数是否执行了单个功能并与其命名相符?
23 不重要 操作符++和— —操作符的应用是否复合规范?
24 重要 单个函数不超过规定行数?
25 重要 缩进层数是否不超过规定?
26 重要 是否已经消除了所有警告?
27 重要 常数变量是否声明为final?
28 重要 对象使用前是否进行了检查?
29 重要 局部对象变量使用后是否被复位为NULL?
30 重要 对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1])。
31 重要 是否确认没有同名变量局部重复定义问题?
32 不重要 程序中是否只使用了简单的表达式?
33 重要 是否已经用()使操作符优先级明确化?
34 重要 所有判断是否都使用了(常量==变量)的形式?
35 不重要 是否消除了流程悬挂?
36 重要 是否每个if-else if-else语句都有最后一个else以确保处理了全集?
37 重要 是否每个switch-case语句都有最后一个default以确保处理了全集?
38 不重要 for循环是否都使用了包含下限不包含上限的形式?(k=0; k<MAX)
39 重要 XML标记书写是否完整,字符串的拼写是否正确?
40 不重要 对于流操作代码的异常捕获是否有finally操作以关闭流对象?
41 不重要 退出代码段时是否对临时对象做了释放处理?
42 重要 对浮点数值的相等判断是否是恰当的?(严禁使用==直接判断)
43 重要 入口对象是否都被进行了判断不为空?
44 重要 入口数据的合法范围是否都被进行了判断?(尤其是数组)
45 重要 是否对有异常抛出的方法都执行了try...catch保护?
46 重要 是否函数的所有分支都有返回值?
47 重要 int的返回值是否合理?(负值为失败,非负值成功)
48 不重要 对于反复进行了int返回值判断是否定义了函数来处理?
49 不重要 关键代码是否做了捕获异常处理?
50 重要 是否确保函数返回CORBA对象的任何一个属性都不能为null?
51 重要 是否对方法返回值对象做了null检查,该返回值定义时是否被初始化?
52 重要 是否对同步对象的遍历访问做了代码同步?
53 重要 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作?
54 重要 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出?
55 不重要 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态?
56 重要 函数对错误的处理是恰当的?
57 重要 实现代码中是否消除了直接常量?(用于计数起点的简单常数例外)?
58 不重要 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )?
59 不重要 是否每个return前都要有日志记录?
60 不重要 是否有冗余判断语句?(如:if (b) return true; else return false;?
61 不重要 是否把方法中的重复代码抽象成私有函数?

审查评价:

优点:

1.代码逻辑清晰,主次分明,函数定义明确,结构完整。

2.命名规范,变量定义及运用有价值。

3.程序运行无报错,无bug。

4.功能强大,计算权值准确,算法效率高

5.代码清晰易懂,容易分析与查看,容易理解作者的思想

6.作者对java的知识有着深刻的理解和熟练的掌握

缺点:

1.返回值未判断是否为空。

2.注释较少,在函数前应指名函数作用

3.没有做变量释放操作。

总评:代码优秀,容易观看,便于分析,有很好的可读性,容易了解作者的思想和创作思维,对搜索和计算权值和计算权值之后的比较有清晰的思路,简捷的代码,方便直接搜索并对其进行比较和操作,在比较时对循环的写法达到了时间最优化,并且返回相应不易造成bug的数值,判断分支简捷易懂,有很清楚的逻辑和客观性很强的代码,作者对树的理解程度很深,并且能用java很轻易地实现,并且很容易使人理解和分析。虽有少部分的缺点,但代码的总体质量很完美。

代码链接:https://github.com/19867382/3/blob/master/software

posted @ 2020-04-13 22:48  计算机1704-邱欣野  阅读(213)  评论(0编辑  收藏  举报