第三周作业（5）——代码规范-CSDN博客

代码规范作业地址：https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147

一，结对要求

1.每2人自愿结成1对，代码规范、单元测试、四则运算试题生成，均由此2人共同完成。

2.要求此2人单元测试和四则运算试题生成编码，在真实物理空间中相距不得超过的距离，可以不借助设备对话。一般地，相距一两米内，2人共同使用同一台显示器、同一套鼠标键盘，可以符合要求。

3.此前累积成绩前10%的同学，禁止彼此结对。

我的结对同学是段晓睿，由于我们是在一个宿舍，对于时间和距离比较好掌握。段晓睿同学的博客地址：https://www.cnblogs.com/ruidxr/

二，代码规范

两个人共同讨论之后，规定了如下规则：

（一）代码编排
1 .缩进:4个空格的缩进（编辑器都可以完成此功能，默认为pycharm的自动缩进），不要使用Tap，更不能混合使用Tap和空格。

2 .每行最大长度79，换行可以使用反斜杠，最好使用圆括号。

3 .函数定义之间空两行,函数内逻辑无关段落之间空一行,其他地方尽量不要再空行。

4.文件使用 UTF-8 编码,文件头部加入#-*-conding:utf-8-*-标识。

（二）空格的使用

1.操作符左右各加一个空格，不要为了对齐增加空格。

2. 不要将多句语句写在同一行。

3. if/for/while语句中，即使执行语句只有一句，也必须另起一行。

4.函数的参数列表中，“,”之后要有空格。

（三）注释

1. 行注释：在一句代码后加注释。“#”号后空一格，段落间用空行分开。尽量避免无意义的注释。

（四）命名规范

1. 函数命名使用全部小写的方式，可以使用下划线。

2. 类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。

3. 尽可能使用‘is’‘is not’取代‘==’，比如if x is not None 要优于if x。

4.变量名尽量小写, 如有多个单词，用下划线隔开。

三、《代码风格规范》执行情况记录

如表：（注：L代表刘欣，D代表段晓睿）

规范	情况记录	更改
规则（一）-1	由于Python中if 和else 的语句缩进要自行控制。L违反12次，D违反8次，互相提醒都已纠正。	规则有效，无更改。
规则（一）-2	有一行添加注释过长，D违反一次，经L提醒纠正一次。	规则有效，无更改。
规则（一）-3	函数内逻辑不清，L和D多次忘记空行。无法统计。	弱化规则，变量定义和功能实现空一行
规则（一）-4	无违反。	规则有效，无更改。
规则（二）-1	L违反15次，经D提醒全部纠正。	规则有效，无更改。
规则（二）-2	无违反。	规则有效，无更改。
规则（二）-3	无违反。	规则有效，无更改。
规则（二）-4	D违反3次，L违反5次，互相提醒全部纠正。	规则有效，无更改。
规则（三）-1	注释过少。	规则有效，无更改。
规则（四）-1	无违反。	规则有效，无更改。
规则（四）-2	D违反两次，经L提醒已更改。	规则有效，无更改。
规则（四）-3	L违反6次，D违反8次，相互提醒已纠正。	规则有效，无更改。
规则（四）-4	无违反。	规则有效，无更改。