0

通常,当您使用 Doxygen 记录代码时,您可以将注释直接放在要记录的任何内容之前或之后。但是,我现在正在处理一些使用结构命令来注释代码的代码(如此处所述:http: //www.doxygen.nl/manual/docblocks.html#structuralcommands)。基本上,所有文档都包含在文件的开头。

不喜欢这种方法,但它似乎在大多数情况下都有效,除了枚举。以下是枚举如何记录的示例。

/*! 
    \enum MyEnum 

    A description of the enum. 

    \var EnumValue1       

           \image html enumimage.png 

           Description of value. 

    \var EnumValue2     

           \image html enumimage.png 

            Description of value. 
*/ 

Doxygen 能够识别枚举及其所有值,但它忽略了值的描述。有人可以告诉我使用结构化命令记录枚举的正确方法是什么吗?(我希望能够避免将所有这些更改为将文档放置在值之前或之后的格式)。

4

1 回答 1

0

尝试:

\var MyEnum EnumValue1

Description of value.
于 2014-01-21T01:00:21.253 回答