2011-09-07 4 views
44

Mis equipos C-escribir el código que sería mejor colocar un '<' en un comentario como se muestra a continuación:¿Por qué un comentario C como/* */need '<'? directrices

#define MAX_PACK_ITEM_NUM 50 /**< max number of item */ 

Me pregunto, ¿cuál es el uso real de este '<'?

+0

Erm, como una flecha? Es un comentario, así que no hay nadie aquí que pueda responder eso. –

+46

¿Cuál es la respuesta de su equipo? – Henrik

+13

¿Por qué la gente quiere cerrar esto? ¡Es una pregunta perfectamente válida! –

Respuesta

73

Es una forma de que doxygen genere documentación para los miembros de un archivo/struct/union/class/enum. Al usar ese marcador, puede poner comentarios después de cada miembro, lo que genera menos desorden. Puede leer más al respecto here.

10

Supongo que su equipo utiliza alguna herramienta de documentación automática que busca /**<; p.ej. Doxygen.

+6

Doxygen, por ejemplo, usa estos corchetes angulares para describir a los miembros, etc. – arne

17

Es un doxygen syntax para comentar miembros después de la declaración/definición.

45

Como han respondido otros, este es probablemente un comentario que está destinado a doxygen. Al analizar los comentarios, Doxygen tener algunas reglas especiales:

  • Un comentario ordinaria a partir de /* es ignorado por doxygen.
  • Un comentario que comience por /** se trata como la documentación del artículo siguiente después del comentario en el código fuente.
  • Un comentario que comience por /**< se trata como la documentación del artículo inmediatamente anterior a el comentario en el código fuente.

La documentación se coloca sobre todo sobre el elemento documentado, p. Una función. Pero en algunos casos, como #define, tiene sentido colocar la documentación al final de la línea y, en ese caso, se necesita el marcador /**<.

Cuestiones relacionadas