复旦大学邱锡鹏fastNLP 平台复现代码规范解读PEP8 Python 编码规范

一起来涨知识呀！

PEP8 Python 编码规范

1.代码编排

• 缩进。4个空格的缩进，不使用Tap，更不能混合使用Tap和空格。
• 每行最大长度79，换行可以使用反斜杠，最好使用圆括号【注意：并没有找到如何用圆括号换行的资料，但是我觉得应该指的是，用圆括号将是一行的东西括在一起】。换行点要在操作符的后边敲回车。【并没有找到操作符的定义】
• 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

2.文档编排

• module(一个py文件)内容的顺序：模块说明，docstring，import xxx（按标准、第三方和自己编写顺序依次排放，之间空一行。），全局变量，常量，其他(类、函数等)定义
• 不要在一句import中多个库，比如import os, sys。
• 如果采用from XX import XX引用库，可以省略‘module.’，但是可能出现命名冲突，这时就要采用import XX（推荐）。

3.空格的使用

• 各种右括号前不要加空格。
• 逗号、冒号、分号前不要加空格。
• 函数的左括号前不要加空格。如Func(1)。
• 序列的左括号前不要加空格。如list[2]。
• 操作符左右各加一个空格，不要为了对齐增加空格。
• 函数默认参数使用的赋值符左右省略空格。
• 不要将多句语句写在同一行。
• if/for/while语句中，即使执行语句只有一句，也必须另起一行。

4.注释

[我觉得不太重要呢]

• 总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！
• 注释必须使用英文࿰