Python编写代码的规范要求

嵌入式技术

1329人已加入

描述

在我们日常生活中,做什么事情讲究规矩,当然我们写程序也不例外,也是有规范的。遵循好的规范可以不仅提高我们代码的可读性,还可以提高程序开发效率。新手和高手之间的差别主要也体现在规范上,这里勇哥主要给大家分享python的PEP8规范,希望大家在编写代码的时候按照规范要求去编写。

1、 变量名,函数名,方法名的命名

1) 命名的名字要力求见名知意;

2) 命名不要和python的关键字(比如while)和内建字重名(比如int);

3) 不能以数字开头,只能由字母,数字和下划线组成;

4) 常量字母都大写,一个单词描述不下可以用下划线连接多个单词来描述。

2、 缩进,空行以及单行字符数要求

1) 使用空格缩进,建议缩进使用4个空格,python是使用缩进来划分代码块;

2) 函数与函数之间要加一个空行,另外函数内部不同功能之间的代码可以加入一个空行以增强代码的可读性。

3) 单行代码不要超过80个字符,超过的话可以使用续行符号来进行连接。

3、 脚本第一行指定编码:# -*- coding: utf-8 -*-

4、 编写程序时,尽量少使用全局变量,易于维护,且对于常量可统一定义在配置文件。

5、 不要在一句import中多个库,比如import os, sys不推荐

导入语句一般顶头写。如果写多个导入语句,建议先写导入内建的模块,然后再导入的第三方模块,最后写导入自定义模块。例如:

python

6、 操作符左右各加一个空格,不要为了对齐增加空格。比如

a + b

7、 在if/for/while语句中,即使执行语句只有一句,也必须另起一行。比如if 3>2:print("ok"),这种写法虽然没错,但是不推荐,需要把print语句另起一行。

8、 适当给代码添加注释,对于比较难理解的或需要特别注意的可以加注释,注释尽量使用完整的句子,要简洁明了。注释写完要另起一行再写其他东西,避免无谓的注释。单行文档注释:"""注释""",引号和文字在同一行。对于函数,类尽量要写上文档字符串(注释)。例如

python

编码也要考虑程序的效率问题

1) 判断序列是否为空,建议按如下规则去写

python

2)尽可能使用'is''is not'取代'==',比如if x is not None 要优于if x==None。

打开APP阅读更多精彩内容
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

×
20
完善资料,
赚取积分