20180925-5代码规范
此作业要求见【https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147】
结对编程成员:
祝玮琦:https://www.cnblogs.com/zwqhh/
孙韦男:https://www.cnblogs.com/swn321/
git 地址:https://git.coding.net/doubanjiang73/second.git(祝)
https://git.coding.net/sunsss/two.git(孙)
作业采用python编写约定按照google的python开源项目风格指南规范格式;同时也参考《构建之法》,制定了2人结对编写的《代码规范》,并在本周作业中遵循。
要求1: 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。比如, 每个函数不超过5行,对于初学者是不切实际的; 大括号匹配纵列对齐,是切实可行的; 变量名易读,是不易检验的,变量名必须是名词短语,遵循熊匈牙利命名法,是易于检验的。
在我和琪琪进行研究之后,我们从三个方面分别进行了以下规范:
一.格式规范:
1.行长度不超过不超过80个字符,如放不下则用括号实现隐式行连接。
2.缩进采用4个空格来缩进代码。
3.括号内不能直接用空格。
4.避免在分号、冒号、逗号前加空格。
5.等于号用于指示关键字参数或默认参数值时,在其两侧不能使用空格。
6.如果一个类不继承自其它类, 就从object继承.,嵌套类同样也要遵循这一规则。
7.导入时每个导入应独占一行。
二.命名规范:
9.关键变量命名要体现出变量的意义,在关键变量上不能使用简单的字母。否则会导致代码的辨识性变差。
三. 注释:
10.注释时要用的#和‘’要注意不能忘记。
要求2: 记录完成本周作业过程中,《代码规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。
规范记录:
代码违规 |
违规次数 |
原因 |
修改规范 |
一.2 |
5 |
不同编译器下编写代码,导致缩进问题 |
无 |
一.3 |
2 |
在括号内不正确的输入了空格 |
无 |
一.4 |
6 |
之前的编写习惯导致违反约定好的规则 |
无 |
一.5 |
3 |
之前其他语言编写习惯导致犯错 |
无 |
一.6 |
2 |
编写类时未写object |
无 |
一.7 |
4 |
进行测试的时候,误将导入写在同一行 |
无 |
二.9 |
3 |
变量命名太过仓促,导致代码易读性大大降低 |
无 |
三.10 |
5 |
总是忘记# |
无 |
在编写代码的过程中,虽然犯错的次数很多,但严格遵守了代码规范,由于之前编写代码,没有太过关注代码规范,使得这次的编程过程有些棘手,但总体来说满足题目要求。
总结:
- 使用对我们有很大的帮助,使代码更加的精确和精准,为代码完成后的运行及测试提供了良好的基础,对我个人来说,让我对书写代码的过程中自我要求更加的严格,是代码的质量得到提高。
- 不等小看任何规范,例如对注释的规范。