條件化html輸出的文本

Question

什麼是條件化文本（而不是代碼）的最佳方式。 有3個級別的文檔，我想條件化和標記爲： 開發人員 - 這將是我不希望doxygen輸出的文檔。比如給開發者的筆記。 內部 - 僅供內部版本文檔可見的信息。 NDA - 爲客戶提供的信息以及任何未標記爲開發人員或內部人員的信息;內部文檔的一個子集，並將過濾掉內部網站。

Answer 1

有許多doxygen命令和配置選項可以幫助您實現這一點。這些包括\internal和\endinternal。從doxygen手冊：

\internal此命令將啓動一個僅供內部使用的文檔片段。

您可以在配置文件中使用INTERNAL_DOCS來顯示（YES）或隱藏（NO）內部文檔。

爲了解決文件的三個版本你想要的：

• 開發：使用標準的C/C++註釋，/* ... */。這些不會被doxygen觸及。

• 內部：對於僅在內部使用的文檔，使用doxygen的註釋，/** ... */，並且包裹的文檔的這些部分與\internal和\endinternal命令。在構建文檔時，在內部分發文檔時將配置文件選項INTERNAL_DOCS設置爲YES。

• NDA：對於文檔visable客戶只需使用Doxygen註釋/** ... */和配置文件在建立文檔時的配置選項INTERNAL_DOCS設置爲NO。