Python基础学习——编码规范

一、命名规范

• 包名：全部小写字母，中间可以由点分隔开，不推荐使用下划线。作为命名空间，包名应该具有唯一性，推荐采用公司或组织域名的倒置。
• 模块名：全部小写字母，如果是多个单词构成，可以采用下划线隔开。
• 类名：采用大驼峰法命名。驼峰命名是指混合使用大小写字母来命名。大驼峰法是所有单词的首字母大写；小驼峰命名法是指第一个单词全部小写，后面的单词首字母大写。
• 异常名：异常属于类，命名同类命名，但应该使用Error作为后缀。
• 变量名：全部小写字母，如果由多个单词构成，可以用下划线隔开。如果变量应用于模块或函数内部，则变量名可以由单下划线开头；变量类内部私有使用变量名可以双下划线开头。不要命名双下划线开头和结尾的变量，这是Python保留的。另外，避免使用小写L，大写O和大写I作为变量名。
• 函数名和方法名：命名同变量命名。
• 常量名：全部大写字母，如果由多个单词构成，可以用下划线隔开。

二、注释规范
Python中注释语法有三种：单行注释、多行注释和文档注释。

• 文件注释：在每一个文件开头添加注释，采用多行注释。文件注释包括的信息如下：版权信息、文件名、所在模块、作者信息、历史版本信息、文件内容和作用等。
• 文档注释：就是文档字符串，注释内容能够生成API帮助文档，可以使用Python官方提供的pydoc工具从Python源代码文件中提取这些信息，也可以生成HTML文件。所有公有的模块、函数、类和方法都应该进行文档注释。文档注释规范有些“苛刻”。文档注释推荐使用一对三重双引号