Doxygen可以转义HTML标签吗?

oz1*_*1cz 3 html doxygen

我想在Doxygen注释中包含文字HTML元素。像这样:

/// This function skips all <li> elements
Run Code Online (Sandbox Code Playgroud)

如果我这样写,它将<li>被传递到HTML输出,这显然不是我想要的。

相反,我可以这样写:

/// This function skips all &lt;li&gt; elements
Run Code Online (Sandbox Code Playgroud)

在Doxygen生成的HTML中,这可以很好地工作,但是现在源代码本身中的注释非常难以辨认。

因此,看起来我必须在生成的文档或源代码的可读性之间进行选择。

确实是这种情况,还是有办法强迫Doxygen自动将其全部<blabla>转换成&lt;blabla&gt;

dox*_*gen 5

您还可以使用:

/// This function skips all \<li\> elements
Run Code Online (Sandbox Code Playgroud)

或(如果MARKDOWN_SUPPORT=YES)写:

/// This function skips all `<li>` elements
Run Code Online (Sandbox Code Playgroud)

既可以合理地读取,也可以将所有内容放在一个\verbatim..\endverbatim节中,但是随后也将其呈现出来。

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

ALIASES = verb{1}="\<\1\>"
Run Code Online (Sandbox Code Playgroud)

然后写

/// This function skips all \verb{li} elements
Run Code Online (Sandbox Code Playgroud)