# python中的__doc__详解

python中的__doc__详解

参考文献

[1] https://stackoverflow.com/questions/33066383/print-doc-in-python-3-script

__doc__为模块字符串，模块字符串写在Python文件的第一行，三个引号包含起来的字符串。

为什么要写文档字符串?
因为规范的书写文档字符串可以通过sphinx等工具自动生成文档。

文档字符串的风格有很多。

• Plain
• Epytext
• reStucturedText
• Numpy
• Google

风格示例

# Plain
def foo1(a, b):
    """

    """
    return a+b

# reStructuredText
def foo2(a, b):
    """
    :param a:
    :param b:
    :return:
    """
    return a+b

# Numpy
def foo3(a, b):
    """
    Parameters
    ----------
    a
    b

    Returns
    -------

    """
    return a+b

# Google
def foo4(a, b):
    """
    Args:
        a:
        b:

    Returns:

    """
    return a + b

# Epytext
def foo(a, b):
    """
    @param a:
    @param b:
    @return:
    """
    return a+b

我们可以在pycharm上进行自定义设置默认的文档字符串风格。暂时推荐reStructuredText吧，紧凑，sphinx御用