如何记录python包

Question

我知道记录函数,类和模块的标准方法是什么,但我如何记录包 - 我是否放入了文档字符串__init__.py或其他内容？

Answer 1

是的,就像函数或类注释一样,__ init__.py文件中的第一项应该是注释字符串:

"""
This is the xyz package.
"""

现在,如果您导入包,并使用help(包),您将看到您的docstring.在此处查看更多信息:http://www.python.org/dev/peps/pep-0257/

Answer 2

参见PEP257

包可以记录在包目录中 __ init __.py 文件的模块文档字符串中。