如何注释掉Doxygen文档中的注释 [英] How to comment out comment in Doxygen documentation

查看:287
本文介绍了如何注释掉Doxygen文档中的注释的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我使用Doxygen的 \ page \subpage \section 构造,以便为我的应用程序提供概述文档。在这里我使用HTML来创建一个格式很好的表。

I am using Doxygen's \page, \subpage and \section constructions to make overview documentation for my application. Somewhere in this I am using HTML to create a nicely formatted table.

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

However, I want to remove a part of the table in the output, without removing the comment itself. 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' 。

I want to remove the line containing 'Do That' without removing the 'text' itself from the file.

如果这是简单的源代码,我可以使用 // / * * /

If this were simple source code, I could simply comment this out using // or /* */.

我发现我可以使用 \if \latexonly (我们只生成html输出),但两者似乎都是一个解决方法(看起来像使用 if(false)

I found out that I could use \if or \latexonly (we only generate html output) but both seem a workaround (looks like using if(false) in code to comment out a block).

在Doxygen中注释掉注释是否有干净的方法?

Isn't there a clean way to comment out comment in Doxygen?

推荐答案

您尝试过\cond \endcond标签吗?此处描述 http://www.stack.nl/~dimitri/doxygen/ manual / faq.html

Did you try \cond \endcond tags? It's described here http://www.stack.nl/~dimitri/doxygen/manual/faq.html

这篇关于如何注释掉Doxygen文档中的注释的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆