打开APP
userphoto
未登录

开通VIP,畅享免费电子书等14项超值服

开通VIP
20180925-5 代码规范

一、结对要求

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

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

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

本次结对作业,我和刘欣同学自愿组成一组,刘欣同学的博客地址为:

 二、《代码规范》在两个人的讨论下,达成共识,制定了如下规范:

(一)代码编排
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.变量名尽量小写, 如有多个单词,用下划线隔开。

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

如表:(注:D代指段晓睿,L代指刘欣)

规范情况记录更改
规则(一)-1由于python中if和else的语句缩进要自行控制,D违反8次,L违反12次,互相提醒都纠正过来了。规则有效,无更改
规则(一)-2有一行添加的注释过长,D违反1次,经L提醒纠正1次。规则有效,无更改
规则(一)-3函数内逻辑不清,L和D多次忘记空行,无法统计。弱化规则,改为变量定义和功能实现之间空一行。
规则(一)-4无违反。规则有效,无更改
规则(二)-1L违反15次,经D提醒全部纠正。规则有效,无更改
规则(二)-2无违反。规则有效,无更改
规则(二)-3无违反。规则有效,无更改
规则(二)-4D违反3次,L违反5次,互相提醒全部纠正。规则有效,无更改
规则(三)-1注释过少,需增加注释。规则有效,无更改
规则(四)-1无违反。规则有效,无更改
规则(四)-2D违反2次,经提醒已纠正。规则有效,无更改
规则(四)-3D违反8次,L违反6次,相互提醒已纠正。规则有效,无更改
规则(四)-4无违反。规则有效,无更改
本站仅提供存储服务,所有内容均由用户发布,如发现有害或侵权内容,请点击举报
打开APP,阅读全文并永久保存 查看更多类似文章
猜你喜欢
类似文章
【热】打开小程序,算一算2024你的财运
Python基础学习
C语言代码规范(编程规范)
简明 Python 编程规范
(转)华为c++编码规范,认为比google的好一点
python的代码规范,超长特别全 看看没有注意的地方,少挨一顿骂
代码书写规范(Java)
更多类似文章 >>
生活服务
热点新闻
分享 收藏 导长图 关注 下载文章
绑定账号成功
后续可登录账号畅享VIP特权!
如果VIP功能使用有故障,
可点击这里联系客服!

联系客服