-
函数的名称应该具有描述性。
-
函数名称只能使用小写字母和下划线,使用下划线的目的是为了提升可读性。
-
仅对非public的函数,开头才可以使用一个下划线。
https://peps.python.org/pep-0008/#function-and-variable-names
-
每个函数都应该包含简要描述其功能的注释。该注释应该紧跟在函数定义后面,并使用文档字符串格式。例如:
(例子来自https://peps.python.org/pep-0257/)
-
给形参指定默认值时,等号两边不要有空格,例如:
def function_name(parameter_1, parameter_2='default value')
- 对于函数调用中的关键字实参,等号两边也不要有空格,例如:
function_name(value_1, parameter_2='value')
- PEP 8建议的代码行的长度不要超过79个字符。如果形参很多,导致函数定义的长度超过了79个字符,可在函数定义中输入左括号以后按回车键,并在下一行按两次Tab键,从而将形参列表和只缩进一层的函数体区分开来。例如:
def function_name(
parameter_1, parameter_2, parameter_3,
parameter_4, parameter_5, parameter_6):
funtion_body...
- 如果程序或模块包含多个函数,可以使用两个空行将相邻的函数分开。
- 所有import语句都应该放在文件开头。唯一例外的情形是,在文件开头使用了注释来描述整个程序。
https://peps.python.org/pep-0008/#imports