【问题标题】:Ignore some comments忽略一些评论
【发布时间】:2011-03-22 10:10:14
【问题描述】:

我正在处理一些遗留代码,为此我使用 doxygen 生成 XML 文档。这种代码有两个问题。首先它包含无效的 cmets。例如:

///@struct E  
enum E  
{
 E1, E2, E3;  
};

这会导致 doxygen 为名称为 E 的结构生成输出,该结构不在代码中。我的第二个问题是 HTML 链接。例如,对于以下输入:

///@brief For info about this struct see: <a href="http://www.foo.com/bar&bar"\>  
struct S
{
  int i;
}

doxygen 生成的输出不是有效的 XML,因为链接中的 &amp; 未正确转义。

出于上述原因,我希望 doxygen 忽略一些 cmets。这可能吗?

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    我不认为 doxygen 对此有一个简单的开关,但是,您可以编写自己的 INPUT_FILTER 程序来在 doxygen 运行之前清理文件(例如,通过去除 cmets)。

    【讨论】:

      【解决方案2】:

      我注意到并测试了 doxygen 注释中的 html cmets 将被忽略:

      ///@brief some comment here <--! ignored here --> also continues over.
      

      至于 & 没有被转义,你有没有注意到 \& 会转义它?也许这是该部分的解决方案。

      【讨论】:

      • 如果你把它改为:##@brief 这里有一些评论 也继续。
      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2013-01-04
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2014-08-06
      相关资源
      最近更新 更多