如何注释掉 Doxygen 文档中的注释答案

【问题标题】：How to comment out comment in Doxygen documentation如何注释掉 Doxygen 文档中的注释
【发布时间】：2023-03-12 12:37:02
【问题描述】：

我正在使用 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”本身。

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

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

难道没有一种干净的方法可以在 Doxygen 中注释掉评论吗？

【问题讨论】：

标签： comments doxygen

【解决方案1】：

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

【讨论】：

在撰写本文时链接已失效。
@KutalmisB 感谢您发现它。我已经使用官方文档参考更新了链接。

【解决方案2】：

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

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

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

【讨论】：

哦，按照您遵循的约定，应该是 \cond ... \endcond。提及完整性。
根据文档，您可以简单地使用 \cond 而无需任何字符串。
@Patrick 是的，但我还是更喜欢在那儿放一些东西来说明清楚。

【解决方案3】：

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

【讨论】：