如何注释掉Doxygen文档的评论(How to comment out comment in Do

我使用的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>

我想删除包含行“做的”，但不从文件中的“文本”本身。

如果这是简单的源代码，我可以简单地评论了这一点，使用//或/* */ 。

我发现我可以使用\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_EXCLUDE在Doxygen的可以看到的任何地方。 DOXYGEN_EXCLUDE正是我所用，这不是一个特殊的关键字，你可以选择你喜欢的任何名称。

Answer 3:

除了\ COND ... \ ENDCOND你也可以使用HTML注释，即<!-- this is a comment in a comment --> Doxygen注释里面，因为在这个页面中手动底部解释HTTP：// WWW .doxygen.org /手动/ htmlcmds.html

文章来源: How to comment out comment in Doxygen documentation