Python3 :编码风格

PEP 8建议

基本

  • 每级缩进都使用四个空格
  • 每行不超过80字符
  • 用空行将程序的不同部分分开
  • 在使用==,>=,<=等比较运算符时在两边各加一个空格

函数编写风格

  • 编写函数时,应给函数指定描述性名称,且只使用小写字母和下划线,给模块命名时也应遵循词约定。
  • 每个函数都应包含简要地描述其功能的注释,该注释应紧跟在函数定义后面,并采用文档字符串格式。
  • 给函数形参指定默认值时,等号两边不要有空格,对于关键字实参也应遵循此约定
  • 若形参很多,可在函数定义中输入左括号都回车,并在下一行按两次Tab键,从而将形参列表和只缩进一层的函数体区分开来。如下:
def function_name(
        parameter_0, parameter_1, parameter_2,
        parameter_3, parameter_4, parameter_5):
    function body...
  • 如果程序或模块包含多个函数,可使用两个空行将相邻函数分开

类和模块编码风格

  • 所有的import语句都应放在文件开头,除非在开头使用了注释来描述整个程序
  • 类的名称采用驼峰命名法,即类名中每个单词的首字母都大写,而不使用下划线。实例名和模块名都采用小写字母,并在单词间使用下划线。
  • 对于每个类,都应在紧跟在类定义后面包含一个文档字符串,用以描述类的功能,每个模块也都应包含一个文档字符串,对其中的类进行描述。
  • 在类中,可使用一个空行来分隔方法;而在模块中,可使用两个空行来分隔类
  • 需要同时导入标准库中的模块和你自己编写的模块时,先导入标准库的模块,再添加一个空行,然后导入自己编写的模块。

你可能感兴趣的:(Python3 :编码风格)