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