3

我正在使用 Doxygen 的\page,\subpage\section结构来为我的应用程序制作概述文档。在某处,我使用 HTML 来创建格式良好的表格。

但是,我想删除输出中表格的一部分,而不删除注释本身。例如

/*!
\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>

我想删除包含“Do That”的行,而不从文件中删除“text”本身。

//如果这是简单的源代码,我可以简单地使用or将其注释掉/* */

我发现我可以使用\ifor \latexonly(我们只生成 html 输出),但两者似乎都是一种解决方法(看起来就像if(false)在代码中使用来注释掉一个块)。

没有一种干净的方法来评论 Doxygen 中的评论吗?

4

3 回答 3

2

你试过 \cond \endcond 标签吗?它在这里描述http://www.doxygen.nl/manual/commands.html#cmdcond http://www.doxygen.nl/manual/commands.html#cmdendcond

于 2013-01-15T11:54:21.607 回答
2

将要排除的部分包含在@cond@endcond块中。像这样:

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

并确保您没有DOXYGEN_EXCLUDE在 doxygen 可以看到的任何地方定义。DOXYGEN_EXCLUDE就是我用的,不是特殊关键字,你可以选择任何你喜欢的名字。

于 2013-01-15T12:01:00.167 回答
1

除了 \cond...\endcond 您还可以使用 HTML 注释,即在 doxygen 注释中,如手册http://www.doxygen.org/manual/htmlcmds.html<!-- this is a comment in a comment -->中本页底部所述

于 2013-01-16T22:12:54.377 回答