在Doxygen上逃脱,#究竟是什么意思?

时间:2016-09-16 20:45:54

标签: c++ escaping doxygen

我试图在Doxygen中转义#以在我的文档中的一个方法的描述中呈现#####EXAMPLE#####,我看到了许多建议但没有任何效果。然后我只使用\#并且它有效。除此之外,我在文本之前和之后使用##并在文本####EXAMPLE####周围创建一个新行,一个空格。现在我想知道它是否正确以及Doxygen中##究竟是什么意思。

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

1 个答案:

答案 0 :(得分:1)

它有三个用途:

  • 启用MARKDOWN_SUPPORT后,它可用于标题,有关详细信息,请参阅手册的this section
  • 创建无序列表时,您可以对每个项目使用-#,有关详细信息,请参阅this section
  • 当链接到符号时,doxygen支持使用Class#方法链接的JavaDoc样式,或仅支持#Global,而不是本机样式Class :: Method或:: Global,请参阅this section以获取更多详细信息。