注释中的“\p”是什么意思?
What does “\p” in comments means?
在阅读LLVM源代码的过程中,我发现注释中有些不同,例如
/// If \p DebugLogging is true, we'll log our progress to llvm::dbgs().
这里的\p
是什么意思?
LLVM 使用 Doxygen 生成文档,///
标记是 many ways 创建特殊注释块的标记之一,Doxygen 将解析该注释块以形成文档。
在一个特殊的注释块中,\p
只是mark-up commands之一,这个特殊的一个以打字机字体呈现以下单词(固定而不是比比例)。 \c
选项是同一事物的别名。
3 斜杠是识别 doxygen 注释的方式之一。
\p 标签有一些含义,请参阅它的文档:https://www.doxygen.nl/manual/commands.html#cmdp
Displays the parameter using a typewriter font. You can use this command to refer to member function parameters in the running text.
我同意。这些似乎是用于格式化打字字体的 Doxygen 命令,但由于其在注释中未显示 'font format' 而是字符本身。
评论不会被 Doxygen 触及或处理。他们有自己的格式。 /c /p 仅在一些重要关键字(方法、成员、参数等)之前,而不是任意的。作者本着好意希望人们识别关键字,但在评论中,所有人都是平等的。
在阅读LLVM源代码的过程中,我发现注释中有些不同,例如
/// If \p DebugLogging is true, we'll log our progress to llvm::dbgs().
这里的\p
是什么意思?
LLVM 使用 Doxygen 生成文档,///
标记是 many ways 创建特殊注释块的标记之一,Doxygen 将解析该注释块以形成文档。
在一个特殊的注释块中,\p
只是mark-up commands之一,这个特殊的一个以打字机字体呈现以下单词(固定而不是比比例)。 \c
选项是同一事物的别名。
3 斜杠是识别 doxygen 注释的方式之一。 \p 标签有一些含义,请参阅它的文档:https://www.doxygen.nl/manual/commands.html#cmdp
Displays the parameter using a typewriter font. You can use this command to refer to member function parameters in the running text.
我同意。这些似乎是用于格式化打字字体的 Doxygen 命令,但由于其在注释中未显示 'font format' 而是字符本身。
评论不会被 Doxygen 触及或处理。他们有自己的格式。 /c /p 仅在一些重要关键字(方法、成员、参数等)之前,而不是任意的。作者本着好意希望人们识别关键字,但在评论中,所有人都是平等的。