人生苦短,你用python吗?
化学专业的小凯,却喜欢上了计算机语言,业余时间入门了python,从此无法自拔,话不多说,接下来与大家分享我的学习笔记。(Python 编码规范)
“无规矩不成方圆”
一.命名规范
程序代码中遍地都是标识符,所以有一个一致的并且符合规范的名字很重要。
1.包名:全部是小写字母,中间可以由点号分开,不推荐使用下划线。
2.模块名:全部是小写字母,如果是多个单词构成,可以用下划线隔开,xiaokai_nihao
3.类名:驼峰法命名 ,XiaokaiNihao
4.异常名:异常名。异常属于类,命名同类命名,但应该使用Error作为后缀。如
FileNotFoundError。
5.变量名:全部小写字母,如果是多个单词构成,可以用下划线隔开。如果变量应用于模块或函数内部,则变量名可以单下划线开头;如果变量类内部私有使用变量名可以双下划线开头。不要命名双下划线开头和结尾的变量,这是Python保留的。另外,避免使用小写L、大写O和大写I作为变量名。
6.函数名和方法名:命名同变量命名。如balance_account、_push_cm_exit
二.注释规范
1.文件注释:采用多行注释,在每一个文件开头添加注释。文件注释通常包括版本信息、文件名、所在模版、作者信息等信息。
# # 版权所有 2015 xxxxxxxxx有限公司# 许可信息查看xxxxx.txt文件# 描述:# 实现日期基本功能# 历史版本:# 2015-7-22: # 2015-8-20: # 2015-8-22: #
上面只是例子,具体要根据实际情况来进行注释。
2.文档注释:文档注释推荐使用一对三重双引号(""")包裹起来,文档注释应该在被注释的模块,函数,类和方法内部的第一条语句。
![](https://img.laitimes.com/img/__Qf2AjLwojIjJCLyojI0JCLicmbw5CNmV2NmZzY0Q2MkFWZlFDMmBjNlFWOzATOjlDNxMWNy8CX0JXZ252bj91Ztl2Lc52YucWbp5GZzNmLn9Gbi1yZtl2Lc9CX6MHc0RHaiojIsJye.png)
如果文档注释在一行能够完成,那么结束的引号也要在这一行;如果文档很长,第一行后面是一个空行,然后在进行注释,开头要与第一个引号对齐,结束的引号要单独在一行,并且和第一个引号对齐。
3.代码注释:代码注释放在一些关键的地方,方便阅读代码的人参考。代码注释要求与球的代码有相同的缩进级别;尾端注释,要求注释的内容极短,而且代码和注释之间应该留最少两个空格。
三.导入规范
导入语句的位置在模块注释和文档注释后面,模块全局变量之前,而且每个导入语句只能导入一个模块。
import reimport structimport binascii
导入语句的顺序是:标准库→第三方库→自己的模块
四.代码排版
1.空行
(1)import语句前后要留两个空行
(2)函数声明前面要留两个空行
(3)类声明前面要留两个空行
(4)方法声明之前要留一个空行
(5)两个逻辑代码块之间要有一个空行
2.空格
(1)赋值符号(=)前后各一个空格
(2)二元运算符要使用空格和操作数分割
a += c + d
(3)括号内不能有空格(括号包括大中小括号)
(4)逗号、冒号、分号前面不能有空格,后面要跟一个空格
(5)参数列表、索引、切片的左括号前面不能有空格
dogs['key'] = list[index]
3.缩进
4个空格为缩进排版的一个缩进级别,代码块的内容相当于首行缩进一个级别
4.断行
一行代码最多有79个字符,文档注释和多行注释一行最多72个字符,如果超过就要断行。
(1)逗号后面断开
(2)在运算符前断开
(3)尽量不要使用续行符(),若有括号,可以在括号里面断行,这样就可以不用续行符()。
规范没必要去刻意的记,在逐渐的学习中,规范是融入代码中的,随着敲代码越来越多,自然而然的就掌握了编码规范。
下一篇笔记分享数据类型
谢谢大家