Python▲Python 代码规范（命名、注释等）( 三 ) Python

def function(a b):
\"\"\"function(a b) -> list\"\"\"
... ...

# 正确的写法
def function(a b):
\"\"\"计算并返回a到b范围内数据的平均值\"\"\"
... ...

对函数参数、返回值等的说明采用numpy标准如下所示

def func(arg1 arg2): \"\"\"在这里写函数的一句话总结(如: 计算平均值). 这里是具体描述. 参数 ---------- arg1 : int arg1的具体描述 arg2 : int arg2的具体描述返回值 ------- int 返回值的具体描述参看 -------- otherfunc : 其它关联函数等... 示例 -------- 示例使用doctest格式在`>>>`后的代码可以被文档测试工具作为测试用例自动运行

文档注释不限于中英文但不要中英文混用
文档注释不是越长越好通常一两句话能把情况说清楚即可
模块、公有类、公有方法能写文档注释的应该尽量写文档注释

三、命名规范1、模块

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

# 正确的模块名
import decoder
import html_parser

# 不推荐的模块名
import Decoder

2、类名

类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

将相关的类和顶级函数放在同一个模块里. 不像Java 没必要限制一个类一个模块.

3、函数

函数名一律小写，如有多个单词，用下划线隔开

4、变量名

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

5、常量

常量使用以下划线分隔的大写命名

【Python▲Python 代码规范（命名、注释等）】