代码规范,结对要求
作业要求【https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147】
代码地址【https://coding.net/u/liuyy0817/p/f4/git】
结伴对象:王一可
要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
比如, 每个函数不超过5行,对于初学者是不切实际的; 大括号匹配纵列对齐,是切实可行的; 变量名易读,是不易检验的,变量名必须是名词短语,遵循熊匈牙利命名法,是易于检验的。
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。
1.空4格,不许使用Tab键。
2.行宽限制为100个字符。
3.在复杂的条件表达式中,用括号清楚的表示逻辑优先级。
4.每个”{“和”}”都独占一行。
5.不把多条语句,多个变量定义在一行上。
6.在变量面前加上有意义的前缀。
7.能用比较准确表明函数意义的名字来命名函数。
8.用下划线分隔变量名字中的作用域标注和变量的语义。
9.多个单词组成的变量名,采用Pascal,所有单词的第一个字母都大写。
10.每个函数前都要写注释。
11.注释不能有汉字或者特殊字符。
规则 | 违反 | 纠正 | 增强、削弱、废除 | 举例 |
1 | 5 | 5 | 增强 | 使用Tab键 |
2 | 0 | 0 | 废除 | 每一行写不够100个字符 |
3 | 3 | 3 | 增强 | 不加括号,产生逻辑问题 |
4 | 6 | 6 | 增强 | 把“}”放在函数尾,没有另起一行 |
5 | 4 | 4 | 增强 | 把变量初始化在同一行 |
6 | 6 | 6 | 增强 | 不加前缀 |
7 | 5 | 5 | 增强 | 用A,B,C来命名函数 |
8 | 1 | 1 | 减弱 | 不使用下划线 |
9 | 13 | 13 | 增强 | 变量名都使用了小写字母 |
10 | 5 | 5 | 增强 | 函数头不加注释 |
11 | 6 | 6 | 增强 | 注释中有汉字 |
我认为,在编写代码之前先制定好代码规范十分重要,这会避免在编写过程中产生不必要的麻烦。