注释中的“ \ p”是什么意思？

Question

在阅读LLVM源代码期间，我发现注释中有一些不同之处，例如

/// If \p DebugLogging is true, we'll log our progress to llvm::dbgs().

\p在这里是什么意思？

Answer 1

LLVM使用Doxygen生成文档，JObject标记是创建特殊注释块的many ways之一，Doxygen将解析该注释块以形成文档。

内的一个特殊注释块///只是mark-up commands之一，该特殊注释块以打字机字体（固定而不是成比例）呈现以下单词。 \p选项是同一事物的别名。

Answer 2

3个斜杠是标识Doxygen注释的方法之一。 \ p标记具有某些含义，请参见文档：https://www.doxygen.nl/manual/commands.html#cmdp

使用打字机字体显示参数。您可以使用此命令在运行文本中引用成员函数参数。

Answer 3

我同意。这些似乎是Doxygen命令，用于格式化打字字体，但由于其注释中未显示“字体格式”，而是字符本身。

Doxygen不会触摸或处理评论。它们具有自己的格式。 / c / p仅在某些重要关键字（方法，成员，参数等）之前，而非任意。作者出于良好的意愿，希望人们识别这些关键字，但在注释中，它们都是平等的。