Docstring

在函数定义内部，我们可以加上 Docstring；将来函数的 “用户” 就可以通过 help() 这个内建函数，或者 .__doc__ 这个 Method 去查看这个 Docstring，即，该函数的 “产品说明书”。

Docstring 可以是多行字符串，也可以是单行字符串：

def is_prime(n):
“”“Return a boolean value based upon whether the argument n is a prime number.”""

if n < 2:
    return False
if n == 2:
    return True
for m in range(2, int(n**0.5)+1):
    if (n % m) == 0:
        return False
else:
    return True

help(is_prime) print(is_prime.doc) is_prime.doc

Help on function is_prime in module __main__:

is_prime(n)
    Return a boolean value based upon whether the argument n is a prime number.

Return a boolean value based upon whether the argument n is a prime number.

'Return a boolean value based upon whether the argument n is a prime number.'

Docstring 如若存在，必须在函数定义的内部语句块的开头，也必须与其它语句一样保持相应的缩进（Indention）。Docstring 放在其它地方不起作用：

Sphinx 版本的 Docstring 规范
Sphinx 可以从 .py 文件里提取所有 Docstring，而后生成完整的 Documentation。将来若是你写大型的项目，需要生成完善的文档的时候，你就会发现 Sphinx 是个 “救命” 的家伙，省时、省力、省心、省命……