第五周
背景:针对学生请假管理系统这个项目,选一段已编写的代码,回答如下问题:
代码:
public class Student implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("学生id")
private String id;
@ApiModelProperty("学生姓名")
private String name;
@ApiModelProperty("密码")
private String password;
@ApiModelProperty("班级")
private Integer classNum;
@ApiModelProperty("性别")
private String sex;
@ApiModelProperty("学院")
private String college;
@ApiModelProperty("年龄")
private Integer age;
@ApiModelProperty("专业")
private String major;
}
一、代码规范采用什么方式?
代码规范采用了命名规范,缩进和空格,注释,代码布局整洁。
二、参考附录中所给的模板,设计本小组项目的“代码复审核查表”
代码复审核查表
概要部分
1)代码符合需求和规格说明么?——符合
2)代码设计是否考虑周全?——周全
3)代码可读性如何?——良好
4)代码容易维护么?——较易
5)代码的每一行都执行并检查过了吗?——执行并检查过了
设计规范部分
1)设计是否遵从已知的设计模式或项目中常用的模式?——遵从
2)有没有硬编码或字符串/数字等存在?——有
3)代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到 Win64)?——不会
4)开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?——有
5)有没有无用的代码可以清除?——目前没有
具体代码部分
1)有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?——有,并检查了返回值和处理了异常
2)参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?——参数传递无错误,字符串的长度是字符的长度,是以0开始计数
3)边界条件是如何处理的?switch语句的default分支是如何处理的?循环有没有可能出现死循环?——没有
4)有没有使用断言(Assert)来保证我们认为不变的条件真的得到满足?——没有
5)对资源的利用,是在哪里申请,在哪里释放的?有无可能存在资源泄漏(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有优化的空间?——有优化空间
6)数据结构中有没有用不到的元素?——没有
效能
1)代码的效能(Performance)如何?最坏的情况是怎样的?——良好,最坏的情况还不可知
2)代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中 string 的操作是否能用StringBuilder来优化)?——目前没有
3) 对于系统和网络的调用是否会超时?如何处理?代码可读性如何?有没有足够的注释?——不会超时,可读性良好,有足够的注释
4)代码是否需要更新或创建新的单元测试?针对特定领域的开发(如数据库、网页、多线程等),可以整理专门的核查表。——不需要
三、运用“代码复审核查表”,回顾本小组项目这段代码
a 确认代码是否容易理解? ——是
b是否符合代码规范?——是
c代码是否正确? ——是
d对于各种边界情况能否正确处理? ——能