代码改变世界

康哲 20190919-5 代码规范,结对要求

2019-09-24 21:03  康哲  阅读(144)  评论(0编辑  收藏  举报

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

结对同伴付宇泽

结对要求,适用于本周所有标注"结对"的作业:

  1. 每2人自愿结成1对,代码规范、单元测试、四则运算试题生成,均由此2人共同完成。
  2. 要求此2人单元测试和四则运算试题生成编码,在真实物理空间中相距不得超过的距离,可以不借助设备对话。一般地,相距一两米内,2人共同使用同一台显示器、同一套鼠标键盘,可以符合要求。
  3. 此前(以当前发布为准,第一次作业)累积成绩前10%的同学,禁止彼此结对

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

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

 

  1. 缩进:4个空格的缩进(编辑器都可以完成此功能,默认为pycharm的自动缩进),不要使用Tab,更不能混合使用Tab和空格。
  2. 函数定义之间空两行,函数内逻辑无关段落之间空一行,其他地方尽量不要再空行。
  3. 不要为了对齐增加无用空格。
  4. 不要将多句语句写在同一行。
  5. 特殊运算符的左右两边都需要加一个空格
  6. 函数的参数列表中,“,”之后要有空格。
  7. 注释:“#”号后空一格,段落间用空行分开。尽量避免无意义的注释。
  8. 函数命名使用全部小写的方式,可以使用下划线。
  9. 函数名称不要取容易混淆的名称
  10. 变量名尽量小写, 如有多个单词,用下划线隔开。

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