20190919-5 代码规范

作业要求参见：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能够给出提示，一定程度上方便了代码规范。

转载于:https://www.cnblogs.com/wkf-/p/11577934.html

20190919-5 代码规范相关推荐

Python 代码规范
前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯目录 Python代码规范一.简明概述 1.编码如无特殊情况, 文件一律使用 U ...
代码规范+设计模式落地之路
欢迎关注方志朋的博客,回复"666"获面试宝典 | 前言刚刚与同事开了一个分享会,笔者分享了一些了代码设计模式相关的内容. 以及复盘了一下项目中有些复杂的业务场景,为什么没有很好 ...
php 代码规范工具,PHP工具篇:PHPStorm IDE使用CodeSniffer代码规范化管理
PHPStorm IDE使用CodeSniffer进行代码规范化管理 PHP_CodeSniffer是一个优秀的代码风格检测工具,定义了一系列的代码规范(通常使用官方的代码规范标准,比如PHP的PSR ...
Verilog代码规范I
Verilog代码规范I "规范"这问题 "规范"这个富含专业气息的词汇(个人感觉),其实规范这种东西,就是大家都约定熟成的东西,一旦你不遵守这个东西,专业人士 ...
vim php代码规范
vim 代码规范工具php-cs-fixer.phar (參考https://github.com/FriendsOfPHP/PHP-CS-Fixer) INSTALL curl http://get ...
Scrum立会报告+燃尽图（十一月十五日总第二十三次）：代码规范与技术交流
此作业要求参见:https://edu.cnblogs.com/campus/nenu/2018fall/homework/2384 项目地址:https://git.coding.net/zhang ...
Web前端开发代码规范（基础）
一. 引言对于一个多人团队来说,制定一个统一的规范是必要的,因为个性化的东西无法产生良好的聚合效果,规范化可以提高编码工作效率,使代码保持统一的风格,以便于代码整合和后期维护. 二. HTML/CS ...
iOS 代码规范总结
前言:代码规范最终的目的是降低代码维护的成本. 代码规范的好处(网上一搜一大把):http://kdboy.iteye.com/blog/407572 一. 结构规范 1.文件夹的建立:注意创建的都是 ...
【辟谣】代码规范固然重要，但是不要再黑程序员了...
昨晚第一次看到一侧关于程序猿代码没有规范而被枪杀的文章,开始有朋友在群里吐槽几个平时代码比较"诗意"的同事,大家也就一笑而过了. 但是,今天朋友圈突然爆发一阵转载热潮,并且还在持续 ...
Python代码规范和命名规范
http://www.imooc.com/article/19184?block_id=tuijian_wz#child_5_1 Python代码规范和命名规范前言 Python 学习之旅,先来看看 ...

20190919-5 代码规范

20190919-5 代码规范相关推荐

最新文章

热门文章