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

标签 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; ?

最佳答案

你也可以使用:

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

关于html - Doxygen 可以转义 HTML 标签吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16316468/

相关文章:

c++ - Doxygen 是否支持分支或 C/C++ 预处理器

c++ - 从 doxygen 的 "README.md"列表中排除 "File documentation"

c++ - Doxygen 链接到 const 函数

html - 元素相互对齐

javascript - 没有 &lt;input&gt; 标签的用户输入

html - 如何使用 html dom 解析器 PHP 在特定 html 标记开始之前获取文本

javascript - 了解 Google map API(简单 map )的代码,以便将其实现到网站中?

doxygen - Doxygen 中的重复输出

c++ - Doxygen:在函数内移动静态变量文档

Java 404 检查器连接正在进行