代码规范总结

1.缩进,对于每级缩进,统一要求四个空格,而不是tab键
2.续行,要求垂直对齐
3.如果表达式跨越多行,那么定界符的扩回符,放置与最后一行非空字符对齐或者
与构造多行的开始第一个字符对齐
4.每行最大长度不超过120字符,过长会导致阅读障碍
5.表达式的赋值符号,左右两侧需要有空格
6.空行,模块的一级函数和类定义之间,需要空两行,
类中函数定义之间,空一行,源文件末尾有且仅有一行空行,每个语句独立一行
可以在代码段中空一行来区分不同业务逻辑块
7.源文件编码统一使用utf-8,# -- coding: utf-8 --
8.模块引用,每个导入应该独立占一行,导入每个分组之间,需要空一行,
标准库导入、第三方库导入、本地导入,禁止导入了模块却不使用
9.注释,所有#开头的注释,必须与代码块同级,并放置在代码之上,#后接一个空格,
行内注释#与代码至少离开两个空格
10.文档字符串,实现描述功能。第一行是文档名,空一行,输入文档描述,
类下面应该定义一个用于描述该类的文档字符串
11.同一个文件中,保持使用字符串引号的一致性,文档字符串必须使用三重双引号
12.严禁定义了变量,却不使用它,会造成困惑,不知道这个变量做什么

你可能感兴趣的:(代码规范总结)