2020-10-28

Python代码规范二

注释

1.1、块注释
“#”号后空一格，段落件用空行分开（同样需要“#”号）

1.2、行注释
至少使用两个空格和语句分开，注意不要使用无意义的注释

2、文档注释
文档注释以 “”" 开头和结尾, 首行不换行, 如有多行, 末行必需换行，如：

“”" 这是一个文档注释案例
注释结束
“”"

命名规范

1、模块
模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)
如：import decoder
import html_parser

2、类名
类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开
如：class Farm():

3、函数
函数名一律小写，如有多个单词，用下划线隔开
如：def run():
pass

def run_with_env():
pass

私有函数在函数前加一个下划线_
class Person():

def _private_func():
    pass

4、变量名
变量名尽量小写, 如有多个单词，用下划线隔开

if name == ‘main’:
count = 0
school_name = ‘’

5、常量
常量采用全大写，如有多个单词，使用下划线隔开

MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600