缩进程序员
4个空格缩进编辑器
行长函数
建议每行不超过80个字符,每行只能容纳79个字符测试
注释的行长不超过72个字符进程
空行文档
如5行建立列表的代码和三行处理列表的代码,用一个空行把两部分隔开,不该该用三四行空行隔开字符串
空行不会影响代码的运行,但会影响代码的可读性import
条件测试的格式设置方面,在如==、<=、>=等比较运算符两边各添加一个空格,例如if age < 4比if age<4好程序
函数方法
编写函数时,要给函数指定描述性名称,只能用小写字母和下划线,给模块命名也要遵照上述约定
每一个函数要包含简要的阐述其功能的注释,注释紧跟函数定义后面,采用文档字符串的格式,文档良好的函数让其余程序员只要阅读文档字符串中的描述就可以使用它
只要知道函数的名称,须要的实参以及返回值的类型,就能在本身的程序中使用它
给形参指定默认值时,等号两边不要有空格,关键字实参也同样
若是形参不少超过了79字符,能够在函数定义中输入左括号加上回车键,在下一行按两下tab,将形参列表和只缩进一层的函数体区分开来,
大多数编辑器都会自动对齐后序参数列表行,缩进程度与你给第一个参数列表行指定的缩进程度相同
若是程序包含多个函数,能够使用两个空行把相邻的函数分开,这样更容易知道前一个函数在什么地方结束,后一个函数在什么地方开始
全部的import语句都应该放在文件的开头,除非文件开头有注释
类
类名应该使用驼峰命名法,即类名中的每一个首字母都要大写,而不使用下划线,实例名和模块名都使用小写格式,并在单词之间加上下划线
每一个类都应该在类定义后包含一个文档字符串,简要的描述类的功能,并遵循编写函数的文档字符串时采用的格式约定
每一个模块也都应包含一个文档字符串,对其中的类可用于作什么进行描述
在类中,用一个空行来分隔方法
在模块中,用两个空行来分隔类
须要同时导入标准库中的模块和你编写的模块时,先编写导入标准库模块中的import语句,再添加一个空行,而后编写导入你本身编写的模块的import语句,这样在包含多条import语句的程序中,这种作法让人更容易明白程序使用的各个模块都来自何方