1

我正在尝试在 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()

任何帮助表示赞赏。

4

1 回答 1

0

答案可以在这里找到。

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

请注意，在这种情况下，不支持 doxygen 的任何特殊命令。

还有另一种使用以“##”开头的注释来记录 Python 代码的方法。这些类型的注释块更符合 doxygen 支持的其他语言的文档块工作方式，这也允许使用特殊命令。

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

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

于 2013-10-30T12:03:57.767 回答