Python编程:从入门到实践
Appendix 1.代码规范 1.1函数编写规范 函数名使用小写字母和单词之间下划线。应给函数指定描述性名称。模块命名也是 每个函数应有简要的DocStrings注释 每个函数都应包含简要地阐述其功能的注释,该注释应紧跟在函数定义后面,并采用文档字符串格式。 DocStrings 文档字符串 给形参指定默认值时,等号两边不要有空格,对于函数调用中的关键字实参,也应遵循这种约定: 在左括号后换行,是函数形参过长的处理办法。 每行代码长度不要超过这根竖线 1.2 类编写规范 类的名称每个单词首字母大写且不使用下划线,实例名和模块名都采用小写格式,并在单词之间加上下划线。 每个类紧跟定义后包含一个文档字符串描述类的功能 可使用一个空行来分隔方法;而在模块中,可使用两个空行来分隔类。 需要同时导入标准库中的模块和你编写的模块时,先编写导入标准库模块的import 语句,再添加一个空行,然后编写导入你自己编写的模块的import 语句。 1.3 测试类、测试函数编写规范 单元测试 是测试函数某一方面是否有问题 测试用例 是一组单元测试 全覆盖式测试 是一整套单元测试 类名包含字样Test 方法名必须以test_打头,这样它才会在我们运行test_name_function.py时自动运行。 1.4 通过空行,划分程序 要将程序的不同部分分开,可使用空行。你应该使用空行来组织程序文件