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

Question

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

例如：

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

我已經嘗試過適用於JavaDoc注釋的建議：使用HTML實體對斜杠進行編碼，如下所示：

* \code
* myFunction() /* Some multi-line comment *&#47;
* \endcode

但這不起作用（我猜因為Doxygen不會替換代碼部分中的HTML實體）。

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

Answer 1

使用不同的評論樣式。

而不是你擁有的，使用：

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

///與/*!相同/*! 並標志着一個doxygen部分。 預處理器將每行視為單行注釋。