作为文档的Docstring一般出现在模块头部、函数和类的头部， 这样在python中可以通过对象的__doc__对象获取文档， 编辑器和IDE也可以根据Docstring给出自动提示。 1) 所有的公共模块、函数、类、方法，都应该写 docstring 。 私有方法不一定需要，但应该在 def 后提供一个块注释来说明。 ~~~ """Return a foobar Optional plotz says to frobnicate the bizbaz first. """ """Oneline docstring""" ~~~ 2) 文档注释以 """ 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例 ~~~ # -*- coding: utf-8 -*- """Example docstrings. This module demonstrates documentation as specified by the `Google Python Style Guide`_. Docstrings may extend over multiple lines. Sections are created with a section header and a colon followed by a block of indented text. Example: Examples can be given using either the ``Example`` or ``Examples`` sections. Sections support any reStructuredText formatting, including literal blocks:: $ python example_google.py Section breaks are created by resuming unindented text. Section breaks are also implicitly created anytime a new section starts. """ ~~~ 4) 不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等 ~~~ # 不推荐的写法(不要写函数原型等废话) def function(a, b): """function(a, b) -> list""" ... ... # 正确的写法 def function(a, b): """计算并返回a到b范围内数据的平均值""" ... ... ~~~ 6) 对函数参数、返回值等的说明采用numpy标准, 如下所示 ~~~ def func(arg1, arg2): """在这里写函数的一句话总结(如: 计算平均值). 这里是具体描述. 参数 ---------- arg1 : int arg1的具体描述 arg2 : int arg2的具体描述 返回值 ------- int 返回值的具体描述 参看 -------- otherfunc : 其它关联函数等... 示例 -------- 示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行 >>> a=[1,2,3] >>> print [x + 3 for x in a] [4, 5, 6] """ ~~~ 8) 文档注释不限于中英文, 但不要中英文混用 9) 文档注释不是越长越好, 通常一两句话能把情况说清楚即可 10) 搜索c