Question

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

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

但是模块怎么样？如何记录 file.py 的内容？

Answer 1

将您的docstring添加为first statement in the module。

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

import foo

# ...

对于包，您可以将文档字符串添加到__init__.py。

Answer 2

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

所有信息均在此处：http://www.python.org/dev/peps/pep-0257/

Answer 3

以下是关于如何记录模块的Example Google Style Python Docstrings。基本上有关于模块的信息，如何执行它以及有关模块级变量和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 
... 
...

Answer 4

你以完全相同的方式做到这一点。将一个字符串作为模块中的第一个语句。

Answer 5

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

Answer 6

对于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是通过将第一个文档字符串放在文件的顶部来触发的。

如何在Python中记录模块？

6 个答案: