Doxygen可以转义HTML标签吗?

时间:2013-05-01 10:28:02

标签: html doxygen

我想在Doxygen评论中包含一个文字HTML元素。像这样:

/// This function skips all <li> elements

如果我这样写,<li>会传递给HTML输出,这显然不是我想要的。

相反,我可以这样写:

/// This function skips all &lt;li&gt; elements

这在Doxygen生成的HTML中运行良好,但现在源代码本身的注释相当难以理解。

所以看起来我必须在生成的文档或源代码中选择易读性。

情况确实如此,还是有办法迫使Doxygen自动将所有<blabla>变成&lt;blabla&gt;

1 个答案:

答案 0 :(得分:4)

您也可以使用:

/// This function skips all \<li\> elements

或(如果MARKDOWN_SUPPORT=YES)写:

/// This function skips all `<li>` elements

两者都具有相当的可读性,或者将所有内容放在\verbatim..\endverbatim部分中,但之后也会这样呈现。

您还可以定义一个别名,即

ALIASES = verb{1}="\<\1\>"

然后写

/// This function skips all \verb{li} elements