Question

我正在使用Doxygen的\page，\subpage和\section结构为我的应用程序制作概述文档。在这个地方，我使用HTML来创建一个格式很好的表。

但是，我想在输出中删除表的一部分，而不删除注释本身。 E.g。

/*!
\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'本身。

如果这是简单的源代码，我可以使用//或/* */对此进行评论。

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

是不是有一种干净的方式来评论Doxygen中的评论？

Answer 1

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

Answer 2

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

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

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

Answer 3

除了\ cond ... \ endcond之外，您还可以在doxygen评论中使用HTML评论，例如，如本手册底部的说明http://www.doxygen.org/manual/htmlcmds.html

如何在Doxygen文档中注释掉评论

3 个答案: