此作业要求参见:https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147
结对同学:田良
要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
一.命名规范
1.变量名尽可能表明变量或函数的作用。
2.使用Pascal大小写风格命名类名,用Pascal形式命名变量名和函数名。
3.使用下划线来分隔变量名字中的作用域标注和变量的语义。
二.注释规范
4.在函数头进行注释,表明函数实现的主要功能。注释使用“#”
5.在重要的语句和代码前也添加注释。注释使用“#”
三.格式规范
6.严格使用4个空格缩进,不使用Tab建。
7.函数之间空一行,操作符两边留一个空格。
8.表达式中用括号清楚地表示逻辑优先级。
9.严禁把多条语句放在同一行上,也不要把多个变量定义在一行上。
四。设计规范
10.每个函数只实现一个单一功能,并且每个函数代码行数不超过40行。
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款规范的执行情况。
规范 | 违反次数 | 情况举例 | 纠正次数 | 规范的执行情况 |
第1条 | 4 | 变量名sum1,sub1 | 4 | 保持不变 |
第2条 | 3 | 用generator表示类名 | 3 | 保持不变 |
第3条 | 5 | judge改为do_judge | 5 | 保持不变 |
第4条 | 3 | 函数generate()前无注释 | 3 | 保持不变 |
第5条 | 6 | 删减了多余的注释 | 4 | 削弱为在关键代码前添加注释 |
第6条 | 6 | 用Tab键取代空格 | 6 | 保持不变 |
第7条 | 7 | ==两边并未加空格 | 7 | 保持不变 |
第8条 | 5 | 显而易见不产生二意的表达式里取消了多余的括号 | 4 | 削弱为在复杂的表达式前添加括号 |
第9条 | 2 | exp,operators写在了同一行 | 2 | 保持不变 |
第10条 | 2 | 函数middle_to_after()代码超过40行 | 1 | 削弱规范为不超过50行 |