python – 有没有办法为嵌套函数生成pydoc？

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了python – 有没有办法为嵌套函数生成pydoc？，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含710字，纯文字阅读大概需要2分钟。

内容图文

我正在寻找一种方法来生成文档,在这种情况下为pydoc,用于嵌套函数.这可能与pydoc一起使用吗？是否可以使用其他工具？

例如：

"""
Module docstring.
"""

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

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

使用：pydoc -w -filename-生成pydoc将为模块和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
        """
        ...

它不是自动的,但它确实意味着您的学生只能看到您希望他们看到的那些私人方法的文档.

内容总结

以上是互联网集市为您收集整理的python – 有没有办法为嵌套函数生成pydoc？全部内容，希望文章能够帮你解决python – 有没有办法为嵌套函数生成pydoc？所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端