- 不要在行尾加分号。
- 每行不超过80个字符!
a. 如果一个文本字符串在一行放不下,可以使用圆括号实现隐式行链接。
b.注释中,较长的url写在一行中。 - 括号使用原则: 宁缺毋滥。
除非是用于实现行连接,否则不要在返回语句或者条件语句中使用括号 - 缩进: 四个空格来缩进代码!不要使用tab!也不要混合使用!
字典中空四个格处理缩进,第一行不要有空格 - 顶级定义之间空两行,比如函数或者类定义;方法定义之间空一行,方法定义,类定义与第一个方法定义之间都是空一行。
- 括号内不要有空格,不要在分号前面加空格,在后边加,除了最后一个分号。二元运算符两边要加空格,“=”指示关键字或者默认参数的时候不要在两侧使用空格。注释不需要对齐。
- #!先用于帮助内核找Python解析器,但在导入模块时,将会被忽略,因此只有直接执行的文件才有必要加入#!。
- 注释用文档字符串。最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.
- 每个导入占一行,忽略大小写。
- 所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的.
用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).
用双下划线(__)开头的实例变量或方法表示类内私有.
将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.
Python书写规范
最新推荐文章于 2024-07-14 18:11:31 发布