如何在Doxygen代碼示例中插入多行註釋

Question

我想在Doxygen文檔中包含一個包含多行註釋的代碼示例。問題在於C++預處理器將*/解釋爲我的Doxygen註釋的結尾，因此文件的語法被破壞。

例如：

/*! \brief My Doxygen comment. 
* 
* \code 
* myFunction() /* Some multi-line comment */ 
* \endcode 
*/ 

我已經嘗試過該協會致力於JavaDoc註釋的建議：使用HTML實體喜歡這個編碼斜線：

* \code 
* myFunction() /* Some multi-line comment */ 
* \endcode 

但是，這並不工作（我猜因爲Doxygen不會替代代碼段中的HTML實體）。

所以問題是：是否可以在代碼示例中包含多行註釋以及如何完成？

Answer 1

使用不同的評論樣式。

而不是你有什麼，用途：

/// \brief My Doxygen comment. 
/// 
/// \code 
/// myFunction() /* Some multi-line comment */ 
/// \endcode 
/// 

的///相同/*!，標誌着一個doxygen的部分。預處理器會將每行視爲單行註釋。