python - 有没有办法将文档字符串与它们记录的函数分开？

Question

我正在开发一个包含许多小函数但其文档字符串往往很长的模块。文档字符串使处理模块变得烦人，因为我必须不断滚动长文档字符串才能找到一些实际代码。

有没有办法将文档字符串与它们记录的函数分开？我真的很想能够在文件末尾远离代码指定文档字符串，或者更好的是，在一个单独的文件中。

Answer 1

函数的文档字符串作为特殊属性 __doc__ 可用。

>>> def f(x):
...     "return the square of x"
...     return x * x
>>> f.__doc__
'return the square of x'
>>> help(f)
(help page with appropriate docstring)
>>> f.__doc__ = "Return the argument squared"
>>> help(f)
(help page with new docstring)

无论如何，这证明了这项技术。在实践中你可以:

def f(x):
    return x * x

f.__doc__ = """
Return the square of the function argument.

Arguments: x - number to square

Return value: x squared

Exceptions: none

Global variables used: none

Side effects: none

Limitations: none
"""

...或任何您想放入文档字符串的内容。