html - Doxygen 可以转义 HTML 标签吗？

Question

我想在 Doxygen 注释中包含一个文字 HTML 元素。像这样的东西：

/// This function skips all <li> elements

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

相反，我可以这样写：

/// This function skips all <li> elements

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

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

真的是这样吗，还是有办法强制 Doxygen 自动<blabla>变成<blabla>?

Answer 1

您也可以使用：

/// 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