Cómo insertar comentarios de varias líneas en los ejemplos de código de Doxygen

Question

Estoy tratando de incluir un ejemplo de código que contenga un comentario de varias líneas en la documentación de Doxygen. El problema es que el preprocesador de C++ interpreta el */ como el final de mi comentario de Doxygen y, por lo tanto, la sintaxis del archivo está rota.

Por ejemplo:

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

ya probé la sugerencia que trabaja por los comentarios JavaDoc: codificar la barra utilizando las entidades HTML como esto:

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

pero esto no funciona (supongo porque Doxygen no reemplaza las entidades HTML dentro de las secciones de códigos).

Entonces la pregunta es: ¿es posible incluir comentarios de varias líneas en el ejemplo del código y cómo se puede hacer?

Answer 1

Use diferentes estilos de comentarios.

En lugar de lo que tiene, su uso:

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

El /// es lo mismo que /*! y marca una parte doxygen. El preprocesador tratará cada línea como un comentario de una sola línea.