Doxygenのコード例に複数行のコメントを挿入する方法

Question

Doxygenのドキュメントに複数行のコメントを含むコード例を含めることを試みています。問題は、C++プリプロセッサが*/をDoxygenコメントの終わりとして解釈するため、ファイルの構文が壊れてしまうことです。例えば

：

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

私はすでにJavadocコメントのために働くの提案を試してみました：

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

が、これは、私は推測する（動作しません。このようにHTMLエンティティを使用してスラッシュをエンコードDoxygenはコードセクション内でHTMLエンティティを置き換えないため）。

したがって、問題は次のとおりです。コード例に複数行のコメントを含めることができますか？どのようにすることができますか？

Answer 1

異なるコメントスタイルを使用してください。代わりにあなたが持っているものの

、使用：

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

///は/*!と同じで、doxygenの部分をマーク。プリプロセッサは、各行を1行のコメントとして扱います。