Python代码规范表
|
格式规范 |
不要用分号结束你的行,也不要用分号把同一行上的两个语句。 |
|
|
最大行长度为 80 个字符。 |
|
|
用 4 个空格缩进代码块。 |
|
|
顶级定义之间有两行空行,可以是函数还是类定义。 |
|
|
方法定义之间和文档字符串之间有一个空行的 a 和第一种方法。一行后没有空行。 |
|
|
相关函数组之间可以用一个空行分隔 |
|
|
函数内逻辑段落之间可以用一个空行分隔 |
|
|
逗号、分号或冒号前没有空格。括号、方括号或大括号内没有空格。没有尾随空格 |
|
|
通常每行只有一个语句 |
|
注释规范 |
确保对模块、函数、方法文档字符串和内联注释。 |
|
|
公共模块、函数、类和方法应该包含文档字符串 |
|
|
使用三重双引号 """ 第一行是简要描述,空一行后是详细描述 |
|
|
以 # 和一个空格开始 |
|
|
与代码至少间隔2个空格 |
|
命名规范 |
名称应具有描述性。 |
|
|
避免使用缩写。 |
|
|
切勿使用破折号 |
|
|
始终使用文件扩展名。 |
|
其他 |
使用 f-string (Python 3.6+) 进行字符串格式化 |
|
|
避免使用 + 连接多个字符串 |
|
|
使用字典推导式和列表推导式 |
|
|
避免使用 map() 和 filter() 除非需要惰性求值 |

浙公网安备 33010602011771号