第四周作业一代码规范

前言

此作业为两人共同完成,结对伙伴为宋雨同学,他的博客地址:http://www.cnblogs.com/songyuu/


 

要求一

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

一、命名规则

  1.函数命名为"主程序名字" + "_" + "具体功能"。可以明确的表示函数实现的功能,避免引用失误导致程序报错。

    例如:def_f4_answer()

  2.关键变量命名要体现出变量的意义,在关键变量上不能使用简单的字母。否则会导致代码的辨识性变差。

    例如:ops,bra,answer

二、格式规范

    本次作业采用python编写。约定按照google的python开源项目风格指南规范格式。

 

  1.行长度不超过不超过80个字符,如放不下则用括号实现隐式行连接。

  2.缩进采用4个空格来缩进代码。

  3.括号内不能直接用空格。

  4.避免在分号、冒号、逗号前加空格。

  5.等于号用于指示关键字参数或默认参数值时,在其两侧不能使用空格。

  6.如果一个类不继承自其它类, 就从object继承.,嵌套类同样也要遵循这一规则。

  7.导入时每个导入应独占一行。

 

 

 


 

 

 

要求二

 

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

  规范记录

代码规范 违反次数 原因 修改规范
一.1 1 命名太过简单,导致对方无法快速理解
一.2 2 变量命名太过仓促,导致代码易读性大大降低
二.1 1 同行字符过于多,导致违反规范
二.2 6 不同编译器下编写代码,导致缩进问题
二.3 3 在括号内不正确的输入了空格
二.4 5 之前的编写习惯导致违反约定好的规则
二.5 7 和二.5原因类似,都是之前其他语言编写习惯导致犯错
二.6 2 编写类时未写object
二.7 1 进行测试的时候,误将导入写在同一行

 

   在进行编写代码时,大多情况都按照之前约定好的规范来编写。定义的规范大多来自于google的python开源项目风格指南,在平时练习python的时候也是按照这一规则来编写程序。所以在结对编写完成代码的时候,并没有出现很大的冲突。制定的规范条款也满足了题目要求。

 


 

 

总结

  1.结对编程要求两个人相互配合进行编写,所以对代码格式必须要有严格的要求。这样不仅能提高代码的易读性,大大提升配合的效率。同时也可以相互监督督促,使自己的的代码风格更为规范。

  2.python语言的语法简洁清晰,相对于c++语言来说,其代码风格更为简便易读。选择了python语言来进行编写程序,使得结对编程的效率提升不少。

  3.关键的变量名以及函数的命名必须要严格遵守规范,否则会大大降低对方对代码的理解。严格按照规范命名关键变量能让对方更快更容易的理解代码,并进行相应的修改。

 

 

posted @ 2017-10-11 12:31  摇滚帝  阅读(148)  评论(0编辑  收藏  举报