2016-09-16 70 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瞭解更多詳細信息。