软件工程第四次作业—代码规范—[结对刘成志]

Posted 2020-10-10 陈建宇

一、 本次代码规范目的

　　(一)制定10条切实可行的代码规范

　　(二)根据制定方案实际执行情况

二、代码规范的要求

代码规范作业地址：https://edu.cnblogs.com/campus/nenu/SWE2017FALL/homework/993

三、代码规范的实施过程

（一）结对编程所制定的十条代码规范：

　　1.括号位置匹配，每一个‘{‘必须在代码结束后的相应位置有与其匹配的‘}’。

　　2.函数中的方法名全部用小写英文显示。

　　3.申请的变量都用小写显示。

　　4.必要的单行注释用‘//’跟在代码下方或后方。

　　5.在函数方法前需要必要的说明用 “/*”和“*/”进行多行注释。

　　6.方法外的全局变量定义为static类型。

　　7.对于前期进行测试的无效代码进行删除。

　　8.方法与方法之间基本会有一到两个Enter键。

　　9.申请的集合设置类型为Object类型，可以放字符串和数值类型。

　　10.基本实现一行一操作代码，增强代码阅读可读性。

（二）规范执行情况：（**注：chen为陈建宇/liu为刘成志）

代码规范约定	规范执行情况	规则是否有效/是否进行更改
括号位置匹配，每一个‘{‘必须在代码结束后的相应位置有与其匹配的‘}’。	if/while条件不自动生成，Chen在if条件处出过两次括号不对齐/liu在代码删除的时候直接将}前面的缩进删到代码后	规范有效/不进行更改
函数中的方法名全部用小写英文显示。	chen触发五次（定义方法名后一个单词首字母用大写）/刘触发两次次（定义方法名每个单词首字母大写）	规范有效/不进行更改
函数中的变量名全部用小写英文显示。	chen触发一次，在定义栈时候变量用大写	规范有效/不进行更改
必要的单行注释用‘//’跟在代码下方或后方。	两人前期同时触发多次（后期代码加注释）	规范有效/不进行更改
函数方法前需要必要的说明用 “/*”和“*/”进行多行注释。	两人前期同时触发多次（后期代码加注释）	规范有效/不进行更改
方法外的全局变量定义为static类型。	chen触发两次（调试时候进行更改）	规范有效/不进行更改
对于前期进行测试的无效代码进行删除。	chen触发八次/liu触发十二次（前期测试代码时候用//或者/**/来注释了不用的代码）	规范有效/不进行更改
方法与方法之间基本会有一到两个Enter键。	liu触发三次	规范有效/不进行更改
申请的集合设置类型为Object类型，可以放字符串和数值类型。	chen触发一次（调试程序过程中发现错误）	规范有效/不进行更改
基本实现一行一操作代码，增强代码阅读可读性。	liu触发三次（多个变量在同行进行定义）	规范有效/不进行更改

三、代码规范总结

　　1.结对编程中因为是两个人一起编程，根据不同人的不同习惯，必要的代码规范还是有必要进行统一的定义。

　　2.相关代码的注释是必要的，可能单个人所写的方法其他人不一定能很快能读懂。

　　3.变量和方法名的定义要有一定意义，不能随意定义。

　　4.必要的换行，增加代码直观阅读性。

　　5.后期调试注明谁在哪块进行调试，修改某块代码。