2013-11-04 46 views
0

問題與Using Doxygen with C, do you comment the function prototype or the definition? Or both?有關。doxygen:html格式的聲明vs C中的定義

Doxygen格式作出聲明,並從我的.h文件中的註釋出現第一,其次的定義,並從我的.c文件的意見。好。

唉,有沒有像\ param [in]或\ return [in]這樣的參數,我可以在html輸出的.c定義之前使用,以便可視地指示「現在我正在描述實現」?它可以在左側放置粗體,甚至可以改變顏色以使其可視化。顯而易見的\ implements標籤不會這樣做。

我看着生成doxygen的HTML代碼,並沒有明顯的CSS類改變。所以我大概應該使用http://www.stack.nl/~dimitri/doxygen/manual/commands.html的標籤。別人使用什麼?

回答

0

一種選擇,這是不理想,但確實有簡單的優點,是使用\note命令。

加前綴描述執行與\note,將導致在與green'y黃色邊欄中的輸出表示段落。你可以改變CSS中的顏色。後續\note段落將保留爲單獨的段落,但具有單個標題和側欄。

的缺點是部分領導注:。這可能會或可能不會被您的需求接受。

可以使用\xrefitem代替,這樣可以讓你的文字更改爲實施:,但是,相當合理,還生成一個單獨的交叉引用頁面上的條目 - 這可能是不可取的。可能有一種禁用交叉索引的方法,但在manual中沒有任何關於它的內容。

我假設你正在生成的單據,僅供內部使用;也許某種形式的技術手冊?在這種情況下,'備註'選項可能是最快最簡單的解決方案。

編輯:我剛剛找到了\remark命令。本質上相當於\note沒有側邊欄,但是相關的標題備註可能更適合您的應用程序。有可能你可以在CSS中添加邊欄。