google code style

注释

文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的doc成员被自动提取, 并且被pydoc所用. (你可以在你的模块上运行pydoc试一把, 看看它长什么样). 我们对文档字符串的惯例是使用三重双引号""" ( PEP-257 ).

一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行.接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐.

模块注释

每个文件应该包含一个许可样板. 根据项目使用的许可(例如, Apache 2.0, BSD, LGPL, GPL), 选择合适的样板。如下图中井号开头的部分：

模块注释.PNG

模块注释-多行.png

函数注释

这里说的函数包括函数, 方法, 以及生成器。函数必须要有文档字符串, 除非它满足以下条件:

• 外部不可见
• 非常短小
• 简单明了

目的：文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了.
要写: 函数做什么, 以及输入和输出的详细描述.
不要写: 描述”怎么做”, 除非是一些复杂的算法.
其他: 复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义.

函数的几个方面应该在特定的小节中进行描述记录, 每节应该以一个标题行开始. 标题行以冒号结尾. 除标题行外, 节的其他内容应被缩进2个空格.

Args:

列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述. 如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受*foo(可变长度参数列表)或者**bar (任意关键字参数), 应该详细列出*foo和**bar.

Returns: (或者 Yields: 用于生成器)
描述返回值的类型和语义. 如果函数返回None, 这一部分可以省略.

Raises:
列出与接口有关的所有异常.

英文注释：
函数注释以动词开头，单数第三人称，首字母大写
好的函数，只用一个动词

char1(str): The first Chinese character to be compared.

函数注释.png

类注释

描述该类, 如果你的类有公共属性(Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相同的格式.

类注释.png

块注释行注释

最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释.

对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.

块注释和行注释.png

导入

导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前.

每个导入应该独占一行.

Yes: import os
     import sys
No:  import os, sys

导入应该按照从最通用到最不通用的顺序分组:

• 标准库导入
• 第三方库导入
• 应用程序指定导入

包导入-按常用程度分组-按字母顺序排列.png

每种分组中, 每部分之间空一行, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.

import foo
from foo import bar
from foo.bar import baz
from foo.bar import Quux
from Foob import ar