【问题标题】:Doxygen for Python: How to generate documentation for nested functionsDoxygen for Python:如何为嵌套函数生成文档
【发布时间】:2015-06-23 08:58:00
【问题描述】:

我正在使用 Doxygen 记录我的 Python 代码。该代码利用了 Python 定义嵌套函数的能力。

所以我将它们记录为“正常”函数并设置EXTRACT_ALL=YES

但是,仍然无法在任何地方找到嵌套函数。有没有办法让 Doxygen 做到这一点?

(Doxygen 版本 1.8.6)

【问题讨论】:

    标签: python doxygen nested-function


    【解决方案1】:

    没有办法访问嵌套函数,所以我确定它只是没有记录它

     def wrapper():
        def nested(a,b,c):
            return a+b+c
        return nested(1,2,3)
    
     #a user can call wrapper()
     print wrapper()
     #but there is no way to call nested
     print nested(7,7,7) #ERROR!!!
    

    既然用户不能调用它,你为什么要记录它?

    (真的这只是一个评论太长,无法作为评论发布)

    【讨论】:

    • 我想记录它,因为我想为未来的开发人员提供完整、格式良好的代码文档,如果 Doxygen 将它包含在其输出中会很好
    • 我个人认为这是回答问题的一个非常重要和有效的观点。
    • @Paddre 好吧,我希望您可能是需要此功能的极少数人之一。幸运的是,Doxygen 是一个开源项目,因此您可以简单地对其进行分支并添加该功能(公平警告它可能比这更值得)
    猜你喜欢
    • 2014-01-17
    • 1970-01-01
    • 1970-01-01
    • 2018-06-07
    • 2016-11-21
    • 2014-09-09
    • 2012-03-26
    • 2018-12-09
    • 1970-01-01
    相关资源
    最近更新 更多