Question

我试图在Python类的描述中添加一个示例。它似乎不是出于某种原因而起作用。该示例被添加到生成的HTML页面上的“示例”选项卡中，但是该示例的链接未显示在该类的描述中。我已经阅读了doxygen手册中有关特殊命令'@example'（http://www.doxygen.nl/manual/commands.html#cmdexample）的部分，但我仍然无法弄清楚如何正确执行。似乎无论我在哪里放置@example命令，都不会显示链接。我正在使用doxygen 1.8.5。

一个简化的Python类，其中应显示示例的链接：

class TestClass:

    ## The constructor.
    #  @param self The object pointer.
    def __init__(self):
        self.__value = 0

    ## Stores a value.
    #  @param value The value to be stored.        
    def setValue(self, value):
        self.__value = value

    ## Gets stored value.
    #  @return The stored value.                
        def getValue(self):
        return self.__value

## @example TestClass_Example.py
#  This is an example of how to use TestClass

示例如下所示：

from TestClass import TestClass

def main():
    myTestClass = TestClass()
    myTestClass.setValue(37)
    print "The stored value is:", myTestClass.getValue()    

if __name__ == '__main__':
    main()

感谢任何帮助。

Answer 1

可以找到答案here。

简而言之：你不能使用doxygen的python语法来使用特殊命令（例如）。您必须使用以##开头的注释，然后使用特殊命令。

请注意，在这种情况下，没有doxygen的特殊命令   支撑。

还有另一种使用注释来记录Python代码的方法   从...开始 ”＃＃”。这些类型的注释块更符合   文档块的工作方式适用于其他语言   doxygen，这也允许使用特殊命令。

编辑：对不起......刚看到你已经这样做了..

你确定doxygen知道文件的路径吗？它在同一个目录中吗？尝试在doxygen配置中设置EXAMPLE_PATH

在Doxygen生成的Python文档中添加一个示例

1 个答案: