Jak wstawić komentarz wieloliniowy w przykładach kodu Doxygen

Question

Próbuję dołączyć przykład kodu, który zawiera komentarz wieloliniowy w dokumentacji Doxygen. Problem polega na tym, że preprocesor C++ interpretuje */ jako koniec mojego komentarza Doxygen i dlatego składnia pliku jest zepsuta.

Na przykład:

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

Próbowałem już sugestię, która pracuje dla komentarzy javadoc: kodowania ukośnik użyciu podmioty HTML tak:

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

ale to nie działa (chyba ponieważ Doxygen nie zastępuje encji HTML w sekcjach kodu).

Pytanie brzmi: czy możliwe jest uwzględnienie komentarzy wielowierszowych w przykładzie kodu i jak można to zrobić?

Answer 1

Użyj różnych stylów komentarzy.

Zamiast tego, co masz, użyj:

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

/// jest taka sama jak /*! i wyznacza część doxygen. Wstępny procesor potraktuje każdą linię jako komentarz jednoliniowy.