20180925-5 代码规范，结对要求

此作业要求参见：https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147。

一、《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格，希望切实可行，容易观察和客观检验。

1.所有的单行注释用‘//’并跟在代码上方。

2.给关键代码加注释，修改代码时应同时修改相应的注释，保证注释与代码的一致性。

3.每次测试之后要删除无用代码。

4.变量命名方式采用匈牙利命名法。

5.增加代码的易读性，对于很长的单行代码，另起一行，规范排版。

6.定义的变量名过长时，适当缩写，但可以被识别出原单词含义。

7.捕捉异常时利用try对用户进行友好的反馈。

8.大括号应单独占一行，并有相应的大括号在同一列对齐。

9.所有的操作符前后加空格。

10.“变量名、函数名，都只敲一遍，以后全部是拷贝+粘贴。”可防止因少或多打一两个字母，而出现的bug问题。

二、 记录完成本周作业过程中，《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数，规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款，说明过于宽松，或你们已经完全"本能"反应，不应作为条款，在本要求及要求1中不得分。此种情况，应补充一条新的条款。 (20分)

如表：（注：W代指王硕，Z代指赵佳璐）

代码规范约定	规范执行情况	规则是否有效/是否进行更改
所有的单行注释用‘//’并跟在代码上方	W触发3次，习惯性写在代码后面	规则有效，无更改
给关键代码加注释，修改代码时应同时修改相应的注释，保证注释与代码的一致性	同时触发多次，时常忘记及时修改注释	规则有效，无更改
每次测试之后要删除无用代码	Z触发2次，W触发3次	规则有效，无更改
变量命名方式采用匈牙利命名法。	Z触发7次，不熟悉命名规则	弱化规则，更改为变量含义对应的英文单词
增加代码的易读性，对于很长的单行代码，另起一行，规范排版。	W触发2次，Z触发1次	规则有效，无更改
定义的变量名过长时，适当缩写，但可以被识别出原单词含义。	Z触发4次	规则有效，无更改
捕捉异常时利用try对用户进行友好的反馈。	W触发3次	规则有效，无更改
大括号应单独占一行，并有相应的大括号在同一列对齐。	W触发1次	强化规则，为增加美观性和代码可读性，大括号对应的if、while和for等也另起一行。
所有的操作符前后加空格。	同时触发多次	规则有效，无更改
变量名、函数名，都只敲一遍，以后全部是拷贝+粘贴。	Z触发3次，经常打错名字造成bug	规则有效，无更改

三、代码规范总结　

1.编写代码的习惯需要批次熟悉和磨合。

2.相关代码的注释可以让读程序的人明白程序编写者的想法。

3.变量和方法名要和实际意义相对应。