python - 有没有办法为嵌套函数生成 pydoc?

标签 python documentation pydoc

<分区>

我正在寻找一种为嵌套函数生成文档的方法,在本例中为 pydoc。 pydoc可以吗?是否可以使用其他工具?

例如:

"""
Module docstring.
"""

def foo(x):
    """
    Foo does something.
    """
    ...

    def bar(y):
        """
        Bar does something
        """
        ...

使用以下方法生成 pydoc:pydoc -w -filename- 将为模块和 foo() 生成 pydoc,但不会为 bar() 生成 pydoc。

通常这样就可以了;问题是我正在尝试建立一个用于教育目的的图书馆,记录闭包内部发生的事情特别有帮助。我想找到一种方法来记录它,而不必将内部函数暴露给全局范围。

最佳答案

总是有手动方法:

"""
Module docstring.
"""

def foo(x):
    """
    Foo does something.
    N.B. Foo includes a local function bar() that does what bar does.
    """
    ...

    def bar(y):
        """
        Bar does something
        """
        ...

这不是自动的,但它确实意味着您的学生只能看到您希望他们看到的那些私有(private)方法的文档。

关于python - 有没有办法为嵌套函数生成 pydoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/18973117/

相关文章:

javascript - 向文本子字符串添加新元素

documentation - 配置 "Class List" View 默认使用Level 2?

r - 使用 Roxygen2 记录 R6 类方法

python - pydoc 将 python 子模块内容注入(inject)主模块

python - 查找最大值及其索引以移动 numpy ndarray 子数组的 pythonic 方法是什么?

python - 从 Matlab 到 Python - 求解函数

python - 如何在 Maya 中通过 Python 创建进度窗口?

go - 如何使用 godoc 与 go 模块一起提供文档?

python - 在外部服务器中运行 pydocs - Python

python - pydoc 不一致?