Come inserire un commento su più righe negli esempi di codice Doxygen

Question

Sto tentando di includere un esempio di codice che contiene un commento su più righe nella documentazione di Doxygen. Il problema è che il preprocessore C++ interpreta lo */ come la fine del mio commento su Doxygen e quindi la sintassi del file è interrotta.

Ad esempio:

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

Ho già provato il suggerimento che funziona per i commenti JavaDoc: codificare la barra utilizzando entità HTML come questo:

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

, ma questo non funziona (immagino perché Doxygen non sostituisce le entità HTML all'interno delle sezioni di codice).

Quindi la domanda è: è possibile includere commenti su più righe nell'esempio di codice e come può essere fatto?

Answer 1

Utilizzare stili di commento diversi.

Invece di quello che hai, l'uso:

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

Il /// è lo stesso di /*! e segna una porzione doxygen. Il pre-processore tratterà ogni riga come un commento a riga singola.