2010-03-27 11 views
8

cuando leí a través de los archivos de origen de los proyectos de código abierto i menudo nos encontramos con algunas frases extrañas en los comentarioscomentarios aspecto divertido -? C++

/*  
@brief ...... 
@usage..... 
@remarks.... 
@par.... 
*/ 

preguntas
1. ¿Cuáles son ellos (se mencionan cuando no se Estaba aprendiendo C++)
2. ¿Tienen alguna documentación (dónde)

+0

Sin embargo, los comentarios de Doxygen en realidad están marcados con/** o /// en lugar de/* y // – sellibitze

Respuesta

16

Son solo comentarios y como tales no tienen ningún significado especial en C++. Probablemente permitan un generador de documentación (por ejemplo, Doxygen) para extraer los datos de los comentarios.

7

Esos son algunos de los sabores del generador automático de documentación. Otro programa ejecuta el código buscando comentarios de como ve allí. Las palabras clave @... identifican cómo se debe diseñar la documentación, y ese programa genera bastante HTML o documentación impresa directamente desde el código fuente. Es una forma de mantener los documentos actualizados con el código más fácilmente.

Cuestiones relacionadas