2013-04-26 60 views
0

通常,當您使用Doxygen記錄代碼時,可以將註釋直接放在記錄的任何記錄之前或之後。不過,我現在正在使用一些使用結構化命令評論代碼的代碼(如此處所述:http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#structuralcommands)。基本上,所有文檔都只包含在文件的開頭。使用結構化命令(doxygen)記錄枚舉

不是這種方法的粉絲,但它似乎大部分工作,除了是枚舉。這是一個如何記錄枚舉的例子。

/*! 
    \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能夠識別enum及其所有值,但忽略了值的描述。有人可以告訴我使用結構化命令記錄枚舉的正確方法是什麼? (我希望能夠避免將所有這些更改爲在文檔之前或之後放置文檔的格式)。

+0

這似乎在使用Doxygen 1.8.3.1做工精細。你用什麼版本的Doxygen?你使用的是默認的Doxygen配置文件嗎?你能否提供你所看到的輸出的屏幕截圖? – DRH 2013-05-02 05:35:33

回答

0

嘗試:

\var MyEnum EnumValue1 

Description of value.