如何在Python中记录模块？

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

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

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

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

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

将您的文档字符串添加为模块中的第一条语句。

"""
Your module's verbose yet thorough docstring.
"""

import foo

# ...

对于软件包，您可以将docstring添加到中__init__.py。

这是有关如何记录模块的Google样式Python文档字符串示例。基本上，有关于模块的信息，如何执行它以及关于模块级别变量和ToDo项目列表的信息。

"""Example Google style docstrings.

This module demonstrates documentation as specified by the `Google
Python Style Guide`_. Docstrings may extend over multiple lines.
Sections are created with a section header and a colon followed by a
block of indented text.

Example:
    Examples can be given using either the ``Example`` or ``Examples``
    sections. Sections support any reStructuredText formatting, including
    literal blocks::

        $ python example_google.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.

Attributes:
    module_level_variable1 (int): Module level variables may be documented in
        either the ``Attributes`` section of the module docstring, or in an
        inline docstring immediately following the variable.

        Either form is acceptable, but the two should not be mixed. Choose
        one convention to document module level variables and be consistent
        with it.

Todo:
    * For module TODOs
    * You have to also use ``sphinx.ext.todo`` extension

.. _Google Python Style Guide:   
http://google.github.io/styleguide/pyguide.html

"""

module_level_variable1 = 12345

def my_function():   
    pass 
... 
...

您可以完全相同地进行操作。将字符串作为模块中的第一条语句。

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

对于PyPI软件包：

如果您在__init__.py文件中添加这样的文档字符串，如下所示

"""
Please refer to the documentation provided in the README.md,
which can be found at gorpyter's PyPI URL: https://pypi.org/project/gorpyter/
"""

# <IMPORT_DEPENDENCIES>

def setup():
    """Verify your Python and R dependencies."""

然后，您将在日常使用帮助功能时收到此信息。

help(<YOUR_PACKAGE>)

DESCRIPTION
    Please refer to the documentation provided in the README.md,
    which can be found at gorpyter's PyPI URL: https://pypi.org/project/gorpyter/


FUNCTIONS
    setup()
        Verify your Python and R dependencies.

请注意，我的帮助DESCRIPTION是通过将第一个文档字符串放在文件的顶部来触发的。