如何在Python中记录模块？

Question

而已。如果要记录函数或类，请在定义之后放置一个字符串。例如：

def foo():
    """This function does nothing."""
    pass

但是模块呢？如何记录 file.py的 功能？

Answer 1

对于软件包，可以在中进行记录__init__.py。对于模块，您可以仅在模块文件中添加文档字符串。

所有信息都在这里：http :
//www.python.org/dev/peps/pep-0257/