c++ - 在 Doxygen 上逃逸，# 到底是什么意思？

Question

我试图在 Doxygen 中转义 # 以在我的文档中的一种方法的描述中呈现 #####EXAMPLE#####，我看到很多建议，但都没有用。然后我只用了 \# 就成功了。除此之外，我在我的文本前后使用了 ##，并且在文本 ####EXAMPLE#### 周围创建了一个新行，一个空格。现在我想知道它是否正确以及 ## 在 Doxygen 中的确切含义。

/*!
 *\brief
 *##
 * \#\#\#\#\#EXAMPLE\#\#\#\#\#
 *##
 * This method bla bla bla
 *
*/
void Classe_name::method()

Answer 1

它有三个用途:

• 当启用MARKDOWN_SUPPORT 时，它可以用于标题，参见this section手册的详细信息。
• 当创建无序列表时，您可以对每个项目使用-#，参见this section了解更多详情。
• 当链接到符号时，doxygen 支持使用 Class#Method 或只是#Global 的 JavaDoc 链接样式，而不是原生样式 Class::Method 或::Global，参见 this section了解更多详情。