如何評論在Doxygen文檔中的註釋

我使用Doxygen的\page,\subpage和\section結構來爲我的應用程序製作概述文檔。在這個地方我正在使用HTML來創建一個很好格式化的表格。如何評論在Doxygen文檔中的註釋

但是，我想刪除輸出中的表的一部分，而不刪除評論本身。例如。

/*! 
\page MAINPAGE Main Page 

<table> 
    <tr> 
     <td>Do This</td> 
     <td>100</td> 
    </tr> 
    <tr> 
     <td>Do That</td> 
     <td>200</td> 
    </tr> 
    <tr> 
     <td>Yet another one</td> 
     <td>300</td> 
    </tr> 
</table>

我想刪除包含'做到這一點'的行而不從文件中刪除'文本'本身。

如果這是簡單的源代碼，我可以簡單地使用//或/* */對此進行註釋。

我發現我可以使用\if或\latexonly（我們只生成html輸出），但兩者似乎都是一種解決方法（看起來像在代碼中使用if(false)來註釋塊）。

是不是有一個乾淨的方式來評論在Doxygen的評論？

來源

2013-01-15 Patrick

您是否嘗試過\ cond \ endcond標記？這裏描述的是http://www.stack.nl/~dimitri/doxygen/manual/faq.html

來源

2013-01-15 11:54:21 Kamil

將要排除的部分包含在@cond和@endcond塊之內。像這樣：

@cond DOXYGEN_EXCLUDE 
<tr> 
    <td>Do That</td> 
    <td>200</td> 
</tr> 
@endcond

，並確保你沒有在Doxygen的可以看到任何地方定義DOXYGEN_EXCLUDE。 DOXYGEN_EXCLUDE就是我用的，它不是一個特殊的關鍵字，你可以選擇你喜歡的任何名字。

來源

2013-01-15 12:01:00

哦，在這個頁面底部的解釋，每個你按照慣例，這將是'\ cond' ...'\ endcond'。提到完整性。 –

根據文檔，您可以簡單地使用\ cond而沒有任何字符串在它後面。 – Patrick

@帕特里克是的，但我仍然喜歡在那裏寫清楚。 –

除了\ COND ... \ ENDCOND你也可以使用HTML註釋，即 Doxygen註釋裏面，因爲在手動http://www.doxygen.org/manual/htmlcmds.html

來源

2013-01-16 22:12:54 doxygen

如何評論在Doxygen文檔中的註釋

回答

相關問題