2016-09-16 107 views
0

我试图在Doxygen中跳过#,在我的文档中对一种方法的描述中提出了#####EXAMPLE#####,我看到很多建议,但没有任何作用。然后,我只使用\#,它的工作。除此之外,我在文本前后使用##,并在文本####EXAMPLE####的周围创建了一个新行,一个空格。现在我想知道它是否正确以及Doxygen中究竟意味着什么##Doxygen逃脱,究竟#是什么意思?

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

回答

1

它有三个用途:

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