Python代码规范

Posted 2021-11-26 666666pingzi

 

1.代码样式规范
　1.行缩进：tap键（4个空格）
　　1.对齐缩进
　　2.层级缩进 （缩进8个空格，比函数体再缩进一个tab）
　　3.\ 换行符，行连接
　2.单行最大字符限制
　　1.所有行限制最大字符数为79
　　2.没有结构化限制的大块文本（文档字符或者注释），每行的最大字符数限制在72
   3.空行
　　1.顶级函数和类之间有两行空行
　　2.类内部的函数定义之间有一行空行
　4.源文件编码方式
　　1.Python3默认文件编码格式utf-8
　　2.Python3中不应有编码声明
   5.调整代码格式 ：ctrl + alt +L

2.注释
　　1.行内注释
　　　　1.行注释是与代码语句同行的注释。行注释和代码至少要有两个空格分隔。注释由
#和一个空格开始
　　2.块注释
　　适用于跟随他们的某些代码，并缩进到与代码相同的级别。块注释的每一行开头使用一个
#和一个空格
　　块注释内部的段落通过只有一个#的空行分隔
　　3.文档注释
　　　　1.文档注释应当使用：3个引号 """ 。来包裹
　　　　2.要为所有的公共模块，函数，类以及方法编写文档说明
　　　　3.非公共方法没有必要添加文档注释，但是应该有一个描述方法具体作用的注释。
这个注释应该在def那一行之后
　　4.单行文档注释："""注释"""，引号和文字在同一行
　　5.多行文档注释：多行文档注释由一个摘要行组成，就像一行文档字符串，后面跟一个
空行，后面是更详细的描述，多行文档说明使用的结尾三引号应该自成一行
例子：
"""摘要。

注释的正文
。。。。。。
"""

3.模块和包相关规范
　　1.导入代码位置
　　　　1.导入常常位于文件顶部，在文档字符串之后，在全局变量和常量之前
　　　2.导入顺序分组：
　　　　1.标准库导入
　　　　2.相关的第三方导入
　　　　3.特定的本都应用/库导入

　　例子：

　　推荐：
　　import requests
　　不推荐
　　from requests import get

4.命名规范
　　1.变量命名
　　永远不要使用字母 l,大写字母O，作为变量名
　　2.函数命名
　　函数名应该小写，多个单词使用 _ 连接
　　3.类命名
　　首字母大写，多个单词使用 _ 连接
　　4.类里面函数和方法参数
　　始终要将self 作为实例方法的第一个参数
　　始终要将cls 作为类静态方法的第一个参数
　　5.包和模块
　　模块名称要断、使用小写、并避免使用特殊符号，尽量保持模块名称简单。无需单词分开（不
　　推荐使用 _ 连接）
　　6.常量
　　所有字母大写使用 _ 连接