此作业要求见:https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147
结对编程成员:祝玮琦、孙韦男
作业采用python编写约定按照google的python开源项目风格指南规范格式;同时也参考《构建之法》,制定了2人结对编写的《代码规范》,并在本周作业中遵循。
要求1: 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。比如, 每个函数不超过5行,对于初学者是不切实际的; 大括号匹配纵列对齐,是切实可行的; 变量名易读,是不易检验的,变量名必须是名词短语,遵循熊匈牙利命名法,是易于检验的。
一.格式规范
1.行长度不超过80个字符,如放不下则用括号实现隐式行连接。
2.缩进采用4个空格来缩进代码。
3.括号内不能直接用空格。
4.避免在分号、冒号、逗号前加空格。
5.等于号用于指示关键字参数或默认参数值时,在其两侧不能使用空格。
6.如果一个类不继承自其它类, 就从object继承.,嵌套类同样也要遵循这一规则。
7.在导入代码时每个导入应该独占一行。
8.代码段落应当合当的用空行分隔开。
二.命名规范
9.关键变量命名要体现出变量的意义,在关键变量上不能使用简单的字母。否则会导致代码的辨识性变差。
三.注释
10.在进行代码注释时需要使用#和‘’进行标识。
要求2: 记录完成本周作业过程中,《代码规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。
规范记录:
代码违规 |
违规次数 |
原因 |
修改规范 |
1 |
0 |
所写代码较简单,行长度小于80个字符 |
在声明变量时,每行应尽量只声明一个变量。 |
2 |
5 |
不同编译器下编写代码,导致缩进问题 |
无 |
3 |
2 |
在括号内不正确的输入了空格 |
无 |
4 |
6 |
由于之前的编写习惯导致违规 |
无 |
5 |
3 |
由于之前的编写习惯导致违规 |
无 |
6 |
2 |
编写类时未写object |
无 |
7 |
4 |
进行测试的时候,误将导入写在同一行 |
无 |
8 |
3 |
忘记代码段落要断开 |
无 |
9 |
3 |
变量命名时过于简单,导致代码易读性大大降低 |
无 |
10 |
5 |
忘记注释符号# |
无 |
总结:
在开始制定《代码规范》时,我们首先查询了关于python编码规范的文章共同制定了2人结对编写的《代码规范》。在执行的过程中,由于个人习惯的问题很多规范执行起来很困难,也让我在编程的过程变得十分烦躁。但当写完后发现规范的命名、缩进、注释让代码在阅读时变得十分容易也利于对代码进行修改、测试,所以我认为这种良好的习惯应该坚持下去。