ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

20190919-5 代码规范

2019-09-25 11:54:52  阅读:243  来源: 互联网

标签:10 缩进 代码 规范 空格 不变 20190919


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

 

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

经阅读《构建之法》第68页至第78页,以及网上学习了解Python编码规范,我和徐姗姗同学共同规定的《代码风格规范》(十项)如下:

(一)命名规范

1.函数名必须与题意和目的相关,体现意义,不能用简单字母(如a,b,c等)代替。

 

(二)格式规范

2.代码必须严格缩进,用4个空格缩进,不用tab缩进。

3.每行不超过80个字符。

4.顶级定义之间空2行,方法定义(函数或类定义)之间空1行。

5.括号内没有空格。

6.在逗号、分号、冒号后面加空格。

7.“=”用于指示关键字参数或默认参数时不在两侧是用空格,作为算数操作符时在两边加一个空格。

8.如果一个类不继承自其他类,就从object集成,嵌套类同样遵循这一规则。

9.导入时每个导入占一行。

 

(三)注释规范

10.在函数后加简单注释说明其功能,且不能描述代码。为提高可读性,注释离开代码至少2个空格。

 

要求2 记录完成本周作业过程中,《代码风格规范》执行情况。

 

规范编号 纠正次数 原因 修改规范
(一)1 3 习惯起简单快捷的名字,但不利于理解,尽量用能表达函数功能的英文作为函数名。 保持不变
(二)2 11 习惯用tab缩进。 保持不变
(二)3 1 代码中有一行超过了80个字符,用"\"分隔成三行。 保持不变
(二)4 7 有时会忽略空两行问题,pycharm会提示。 加强,应养成编程习惯
(二)5 4 括号内不该加空格时加了空格。 保持不变
(二)6 10 其中逗号后面加空格纠正次数最多。 加强,应养成编程习惯
(二)7 3 习惯于无论“=”起什么作用都在两边加空格。 保持不变
(二)8 1 编写类时对object不熟悉。 保持不变
(二)9 1 将导入写在了同一行。 保持不变
(三)10 3 注释没有注重强调功能。 保持不变

 

总结:

1.采用代码规范在很大程度上提高了代码的可读性。规范中的(二)主要来源于google的python编码规范,对于我这样的初学者,应该从学习之初就养成良好的编码习惯。

2.在结对过程中,对于一个人没有发现的问题或不好理解的部分,可以及时互相指出并纠正,提高了效率。

3.python语言比较精炼简洁,对于部分编码不规范的地方,pycharm能够给出提示,一定程度上方便了代码规范。

 

标签:10,缩进,代码,规范,空格,不变,20190919
来源: https://www.cnblogs.com/wkf-/p/11577934.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有