软件工程第一次结对作业

源代码地址

本次我的结对伙伴是王新哲，她的源代码是用java语言实现了一个小游戏：贪吃蛇

java贪吃蛇算法审查表

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

整体程序的思路分析：

• 程序功能： 贪吃蛇游戏是通过键盘控制蛇移动的方向，在由Canvas函数构建的画布上随机生成一些食物，通过键盘控制蛇的移动方向去吃食物，当蛇头和食物的坐标重合时，代表此时蛇吃到了食物，这时count要进行加1操作，实现计分功能；当蛇头超过设置的最大的坐标时，认为蛇此时撞到了墙壁，则游戏结束，或者键盘操作不合理时认为游戏结束，比如：蛇头超左前进，用户却按下了让蛇超右前进的方法；或者蛇头和自己的身体相撞时认为游戏结束。一共上述三种情况下认为游戏结束。
• 整个程序跟用户的接口使用了java自带awt和swing组件，用户对蛇的控制通过键盘监听函数实现，食物的生成用随机函数，蛇的表示和食物的表示都采用了坐标的方式，用于跟用户的交互界面的现实以及绘制蛇和食物都是通过paint函数实现。

代码的优缺点分析：

• 优点：
  • 整个代码模块清楚，整体符合代码编程规范，每个函数模块的功能都加了注释，每个for循环的功能也都有说明，思路清晰，对数组的访问也合理的控制了下标。
• 缺点：
  • 代码注释的位置不太清晰，位置不太合乎规 范 。
  • 另外，这个功能代码中使用了大量的java GUI接口组件函数，感觉加点注释可能会更加清楚 。
  • 代码中定义了多个变量，没有对变量加以注释
  • 函数和函数之间没有使用空行，以便使程序结构更加清楚
  • for循环{}不合规范

总结：

总体逻辑清晰，合乎代码规范要求，但有些细节的地方加以改进可以增加程序的可读性。