使用Python的docstring

程序员一直以来都有一个烦恼，他们只想写代码，不想写文档。他们说：代码就表达了我的思想和灵魂。

小公司相对随意一些，可以先写代码调试，但是最后老板害怕程序员离职造成“青黄不接”，还是会要求补上文档。大公司要求更高，要先写文档，评审通过，然后再开始编码。有的程序员整天都在写文档，苦不堪言。

Python提出了一个方案，叫docstring，来试图解决这个问题。即编写代码，同时也能写出文档，保持代码和文档的一致。

Python提出的这个方案其实并不新鲜，docstring说白了就是一堆代码中的注释。任何编程语言都有注释的好不好！！不过，Python的docstring可以通过help函数直接输出一份有格式的文档，这个就厉害了。代码写完，注释写完，一个help调用，就有文档看了。

docstring可以写在三个地方：模块或包，对象，函数。

（以下示例使用著名的requests包）

对于模块，docstring就是在模块文件的最前面，如下示例：

# -*- coding: utf-8 -*-

"""
requests.api
~~~~~~~~~~~~

This module implements the Requests API.

:copyright: (c) 2012 by Kenneth Reitz.
:license: Apache2, see LICENSE for more details.
"""

from . import sessions

docstring使用三个双引号（”），triple double quote for docstring，这是PEP0257里的约定。

对于包，docstring就是在package的__init__.py这个文件的任何语句的前面（docstring的前面还可以有#注释），如下示例：

# -*- coding: utf-8 -*-

#   __
#  /__)  _  _     _   _ _/   _
# / (   (- (/ (/ (- _)  /  _)
#          /

"""
Requests HTTP Library
~~~~~~~~~~~~~~~~~~~~~

Requests is an HTTP library, written in Python, for human beings. Basic GET
usage:

   >>> import requests
   >>> r = requests.get('https://www.python.org')
   >>> r.status_code
   200
   >>> 'Python is a programming language' in r.content
   True

... or POST:

   >>> payload = dict(key1='value1', key2='value2')
   >>> r = requests.post('http://httpbin.org/post', data=payload)
   >>> print(r.text)
   {
     ...
     "form": {
       "key2": "value2",
       "key1": "value1"
     },
     ...
   }

The other HTTP methods are supported - see `requests.api`. Full documentation
is at <http://python-requests.org>.

:copyright: (c) 2017 by Kenneth Reitz.
:license: Apache 2.0, see LICENSE for more details.
"""

import urllib3

对于函数，docstring就是在函数定义的最前面，如下示例：

def get(url, params=None, **kwargs):
    r"""Sends a GET request.

    :param url: URL for the new :class:`Request` object.
    :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`.
    :param \*\*kwargs: Optional arguments that ``request`` takes.
    :return: :class:`Response <Response>` object
    :rtype: requests.Response
    """

    kwargs.setdefault('allow_redirects', True)
    return request('get', url, params=params, **kwargs)

注意上例的三个双引号前有个r，r是raw的意思，表示这个字符串里面的\就是它自己，不是用来转意的。

对于对象定义，docstring就是在class定义的最前面，如下示例：

class Timeout(RequestException):
    """The request timed out.

    Catching this error will catch both
    :exc:`~requests.exceptions.ConnectTimeout` and
    :exc:`~requests.exceptions.ReadTimeout` errors.
    """


class ConnectTimeout(ConnectionError, Timeout):
    """The request timed out while trying to connect to the remote server.

    Requests that produced this error are safe to retry.
    """

还有一种单行docstring的写法，如下：

def getStartLink():
    """get start link"""
    startLink = str()
    
    # get start link value
    if __name__ == "__main__":

Python builtin的help函数主要是在交互模式下使用，在交互模式下，使用help，就能够看到文档中的这些被称为docstring的注释，被一种良好的格式显示出来。

在调整代码的时候，维护注释，维护docstring，进而保持代码和文档（help函数的输出）一致，麦新杰认为是一种简化的思想。docstring不是强制的，如果不写，help函数的输出就是空空的。

下面是help(requests)的输出：

>>>
>>> import requests
>>> help(requests)
Help on package requests:

NAME
    requests

DESCRIPTION
    Requests HTTP Library
    ~~~~~~~~~~~~~~~~~~~~~

    Requests is an HTTP library, written in Python, for human beings. Basic GET
    usage:

       >>> import requests
       >>> r = requests.get('https://www.python.org')
       >>> r.status_code
       200
       >>> 'Python is a programming language' in r.content
       True

    ... or POST:

       >>> payload = dict(key1='value1', key2='value2')
       >>> r = requests.post('http://httpbin.org/post', data=payload)
       >>> print(r.text)
       {
         ...
         "form": {
           "key2": "value2",
           "key1": "value1"
         },
         ...
       }

    The other HTTP methods are supported - see `requests.api`. Full documentatio
n
    is at <http://python-requests.org>.

    :copyright: (c) 2017 by Kenneth Reitz.
    :license: Apache 2.0, see LICENSE for more details.

PACKAGE CONTENTS
    __version__
    _internal_utils
    adapters
    api
    auth

看description部分，这就是写requests包的__init__.py文档中的docstring。

而且还可以看出，help函数不仅输出docstring，还有一些其它的格式化的输出信息，非常handy呀。

专业的Python docstring文档，请参考PEP257

您可能要先看一下：什么是PEP文档？

Python这种语言简单易学，有个原因就是它将一些复杂的事情简化了，比如非强制的docstring，比如强制缩进。

相关文章

• Python用函数创建装饰器
• 计算python程序运行时间
• 理解Python的Dynamic typing
• Python中的assert语句
• Python将list中某个元素移至末尾
• 判断一个python对象是否可迭代？
• 用Python实现将数字转换为逗号分隔形式的字符串
• python如何判断变量类型
• Python的zip()函数用法
• Python的任意个数参数的函数设计
• 将图片变为.py文件（image to .py）
• 在Python实现动态加载模块
• Python的and和or运算符
• 运行GUI Python程序，不显示console窗口
• 删除Python中List或Dict的某一个元素
• Python字典（Dictionary）setdefault()函数理解
• Python的模块和包
• Python的PEP文档是什么？
• Python赋值语句中的条件判断
• 使用import加载Python模块时的路径
• 设置Python的PYTHONPATH环境变量
• 搭建Python的Linux开发环境
• getattr()、setattr()以及hasattr()
• 在排序函数中使用Lambda表达式（Python）
• Python循环语句中的else分支
• Python的新式类（new style class）
• 解决RuntimeError: main thread is not in main loop
• Python的map函数的用法
• Python两种遍历dict数据类型的方法
• Python正则表达式re模块的用法