python代码编写规范

1、缩进

python程序是通过依靠代码块的缩进来体现代码块之间的逻辑关系。

对于with块、类定义、函数定义、选择结构、循环结构以及异常处理结构来说,行尾的冒号以及下一行的缩进表示一个代码块的开始,缩进结束则表示一个代码块结束了。在编写程序时,同一个程序的代码块的缩进量必须相同。
python代码编写规范
Format------Indent Region/Dedent Region
也可以使用快捷键ctrl+]或Tab键缩进,使用快捷键ctrl+[反缩进。

2、注释

注释对于程序理解和团队合作开发具有非常重要的意义。

一个可维护性和可读性都很强的程序一般会包含30%以上的注释。

python中常用的注释方式有两种

项目 Value
1 以符号#开始,表示本行#之后的内容为注释。
2 包含在一对三引号(‘’‘…’’’)或(‘’’’’‘…’’’’’’)之间且不属于任何语句的内容将被解释器认为是注释

3、每个import语句只导入一个模块,尽量避免一次导入多个模块。

4、语句太长可以在行尾使用续行符’’’’,来表示下面紧接的一行任然属于当前的语句,也可以使用括号来包含多行内容。

5、使用必要的空格和空行增强代码的可读性。

一般来说,运算符两侧,逗号后面建议增加一个空格。

不同功能的代码块之间、不同函数定义以及不同的类定义之间则建议加一个空行。

6、适当使用异常处理结构可以增加程序的健壮性和可读性以及容错性。

但是不能过度使用异常处理结构。

适当的显示结构是必要的。

7、软件应当具有较强的可测试性,测试与开发齐头并进。