如何在Python中记录模块?

时间:2020-03-05 18:47:42  来源:igfitidea点击:

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

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

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

解决方案

回答

很简单,我们只需在模块顶部添加一个文档字符串即可。

回答

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

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

回答

我们执行完全相同的方法。将字符串作为模块中的第一条语句。