多彈頭Doxygen @note？

Question

在非Doxygen的意見，我經常有：

/* Lorem ipsum etc. 
* 
* Notes: 
* - A first note. 
* - Some other note note. 
*/ 

但隨着Doxygen的，我有@note（或\note），不@notes）。那麼，我應該使用多個@note嗎？還是我將所有筆記放在同一個@note下？

Answer 1

你可以這樣做;這實際上是一種風格/偏好的問題。

正如您所指出的，Doxygen有@note命令，但不是@notes。您可以通過編輯的Doxyfile，並修改ALIASES =標記爲@notes創建自己的命令來讀取

ALIASES = "notes=@par Notes:\n" 

有了這個，你可以把命令@notes的文檔，這將導致與用戶定義的段落標題

注：

正如Doxygen documentation for the ALIAS tag指出的那樣，你可以將\ n放入別名的值部分以插入換行符。

Answer 2

@note命令生成的段落格式可以在使用Latex時在CSS文件或樣式文件中自定義。所以，你可以只使用標記像一個「正常」的文本：

/** 
* Bla bla... 
* 
* @note Even in a note you can use markups: 
*  - Your first note 
*  - Youre second note 
* 
* The note section ends with an empty line or the end of the comment. 
*/