Python类编码风格

来源:互联网 发布:好喝的白酒 知乎 编辑:程序博客网 时间:2024/06/07 02:55
类编码风格
你必须熟悉有些与类相关的编码风格问题, 在你编写的程序较复杂时尤其如此。
类名应采用驼峰命名法 , 即将类名中的每个单词的首字母都大写, 而不使用下划线。 实例名和模块名都采用小写格式, 并在单词之间加上下划线。
对于每个类, 都应紧跟在类定义后面包含一个文档字符串。 这种文档字符串简要地描述类的功能, 并遵循编写函数的文档字符串时采用的格式约定。 每个模块也都应包含一个文
档字符串, 对其中的类可用于做什么进行描述。
可使用空行来组织代码, 但不要滥用。 在类中, 可使用一个空行来分隔方法; 而在模块中, 可使用两个空行来分隔类。
需要同时导入标准库中的模块和你编写的模块时, 先编写导入标准库模块的import 语句, 再添加一个空行, 然后编写导入你自己编写的模块的import 语句。 在包含多
条import 语句的程序中, 这种做法让人更容易明白程序使用的各个模块都来自何方。
原创粉丝点击