python基本规范

缩进规范:

1. 使用四空格缩进

2. 每行最大长度79个字符


空行规范:

1. 全局的(文件级别的)类和全局的函数上方要有两个空行

2. 类中的函数上方要有一个空行

3. 函数内部不同意群的代码块之前要有一个空行

4. 不要把多行语句合并为一行(即不要使用分号分隔多条语句)

5. 当使用控制语句if/while/for时,即使执行语句只有一行命令,也需要另起一行

6. 代码文件尾部有且只有一个空行


空格规范

1. 函数的参数之间要有一个空格

2. 列表、元组、字典的元素之间要有一个空格

3. 字典的冒号之后要有一个空格

4. 使用#注释的话,#后要有一个空格

5. 操作符(例如+,-,*,/,&,|,=,==,!=)两边都要有一个空格,不过括号(包括小括号、中括号和大括号)内的两端不需要空格


换行规范:

1. 一般我们通过代码逻辑拆分等手段来控制每行的最大长度不超过79个字符,但有些时候单行代码还是不可避免的会超过这个限制,这个时候就需要通过换行来解决问题了。

2. 两种实现换行的方法:

第一种,通过小括号进行封装,此时虽然跨行,但是仍处于一个逻辑引用之下。比如函数参数列表的场景、过长的运算语句场景

第二种,直接通过换行符(\)实现


文档规范:

1. 所有import尽量放在代码文件的头部位置

2. 每行import只导入一个对象

3. 当我们使用from xxx import xxx时,import后面跟着的对象要是一个package(包对应代码目录)或者module(模块对应代码文件),不要是一个类或者一个函数


注释规范:

1. 代码块注释,在代码块上一行的相同缩进处以 # 开始书写注释

2. 代码行注释,在代码行的尾部跟2个空格,然后以 # 开始书写注释,行注释尽量少写

3. 英文注释开头要大写,结尾要写标点符号,避免语法错误和逻辑错误,中文注释也是相同要求

4. 改动代码逻辑时,一定要及时更新相关的注释


文档描述规范:

 三个双引号开始、三个双引号结尾;

首先用一句话简单说明这个函数做什么,然后跟一段话来详细解释;

再往后是参数列表、参数格式、返回值格式的描述

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。