20190919-5 代码规范，结对

此作业要求参见：https://edu.cnblogs.com/campus/nenu/2019fall/homework/7630

结对伙伴：杨萍

参见教材第68页至第78页，2人结对编写《代码规范》，并在本周作业中遵循。

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

     1、缩进：采用4个空格，4个空格的距离使得代码可读性比较高，不用Tab键。

     2、括号：在复杂的条件表达式中，用括号可以很清楚的表示逻辑优先级。

     3、分号：不要在行尾加分号，也不要用分号将两条命令放在同一行。

     4、分行：不要把多个变量定义在一行上面。

     5、命名：变量命名方式采用匈牙利命名法，方便阅读理解，增强程序可读性。

     6、注释：复杂的注释放在函数头，用来解释参数的类型，并且注释要随着程序的修改而不断更新，以便后期阅读代码。

     7、函数名：函数名一律小写，如有多个单词，用下划线隔开；私有函数在函数前加一个下划线_。

     8、变量名：变量命名方式采用匈牙利命名法，尽量小写, 如有多个单词，用下划线隔开，方便阅读理解，增强程序可读性。

     9、空格：运算符左右加空格，使得代码简洁明了。

     10、空行：模块级函数和类定义之间空两行，类成员函数之间空一行。

参考链接：https://www.cnblogs.com/ltb6w/p/10847612.html

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

 

条款	代码规范类型	违反次数	违反情况	规范措施
1	缩进	12	由于个人习惯性用Tab键，导致多次没按要求缩进	增强：多次纠正习惯，不用Tab键使得代码更加规范
2	括号	3	忘记加括号导致运算错误	保持不变
3	分号	17	由于个人习惯，在python编程中总习惯性加分号，多次报错	增强，python编程中语句末尾不加分号，简化了代码
4	分行	1	语句过长，超出规范	保持不变
5	命名	6	没按匈牙利命名法，导致代码可读性下降	增强，按匈牙利命名法命名，增强代码可读性
6	注释	13	习惯性用//注释单行代码，与python注释规范不符，而且#后没空一格	削弱
7	函数名	3	没有小写，导致多次违反规范	保持不变
8	变量名	9	命名可读性不高，过长的变量名又没使用下划线分隔	保持不变
9	空格	24	运算符左右忘记空格，使得代码不规范	增强
10	空行	5	模块级函数和类定义之间空一行，类成员函数之间空一行。	增强，模块级函数和类定义之间空两行，类成员函数之间空一行