Python基础-05-注释规范&代码排版

来源：《Python从小白到大牛》关东升

注释规范

文件注释

就是在每一个文件开头添加注释，采用多行注释。文件注释通常包括如下信息：
版权信息、文件名、所在模块、作者信息、历史版本信息、文件内容和作用等

文档注释

文档注释就是文档字符串，注释内容能够生成API帮助文档，可以使用Python官方提供的pydoc工具从Python源代码文件中提取这些信息，也可以生成HTML文件。
所有共有的模块、函数、类和方法都应该进行文档注释。

代码排版

空行
1、import语句块前后保留两个空行
2、函数声明之前保留两个空行
3、类声明之前保留两个空行
4、方法声明之前保留一个空行
5、两个逻辑代码块之间应该保留一个空行

空格
1、赋值符号“=”前后各有一个空格
2、所有的二元运算符都应该使用空格与操作数分开
3、一元运算符：算法运算符取反“-”和运算符取反“~”
4、括号内不要空格，Python中括号包括小括号“（）”、中括号"[]"和大括号“{}”
5、不要在逗号、分号、冒号前面有空格，而是要在他们后面有一个空格，除非该符号已经是行尾了。
6、参数列表、索引或切片的左括号前不应有空格

缩进
4个空格经常被作为缩进排版的一个级别

断行
1、在逗号后面断开
2、在运算符前面断开
3、尽量不要使用续行符“\”，当有括号（包括大括号、中括号和小括号）则在括号中断开，这样可以不使用续行符。