代码建议统一使用pep8规范加上部分最佳实践。
风格指南是关于一致性的。风格一致对一个项目更重要。
Guido 的主要洞察力 (key insights) 之一是:代码更多是用来读而不是写。
故本指南致力于改善 Python 代码的可读性、使不同的 (wide spectrum) Python 代码 保持一致性。
python code comment style
pep8规范 代码pep8规范可以使用python pep8工具做检查.
安装方法 pip install pep8
使用方法 pep8 <python文件>
一般IDE工具都会有集成,可以在编写代码的工程中做pep8校验. 可自行google设置方法。
代码布局 每级缩进用 4 个空格。
建议使用4个空格代替tab,最流行的 Python 缩进方式是仅使用空格
绝不要混合使用 tab 和空格。建议打开IDE中的tab和空格(或至少显示行尾空格)显示。
限制所有行的最大行宽为 79 字符。
折叠长行的首选方法是使用 Python 支持的圆括号、方括号 (brackets) 和花括号 (braces) 内的行延续。
如果需要,你可以在表达式周围增加一对额外的圆括号,但是 有时使用反斜杠看起来更好。确认恰当地缩进了延续的行.
用两行空行分割顶层函数和类的定义。 类内方法的定义用单个空行分割。
在函数中使用空行时,请谨慎的用于表示一个逻辑段落 (logical sections)。
python文件应统一使用utf8编码,并建议在文件头加生utf8声明。 申明头如下
## 格式一 # -*- coding: utf-8 -*- ## 格式二 #!
Jan 8, 2016
1 min read