c++ - react - tag lib jstl
¿Por qué un comentario de C como/**/ necesita ''<''? (4)
Como otros han respondido, este es probablemente un comentario que está destinado a doxygen. Al analizar los comentarios, doxygen tiene algunas reglas especiales:
- Un comentario ordinario que comienza con
/*es ignorado por doxygen. - Un comentario que comienza con
/**se trata como documentación del siguiente elemento después del comentario en el código fuente. - Un comentario que comienza con
/**<se trata como documentación del elemento inmediatamente antes del comentario en el código fuente.
La documentación se coloca principalmente sobre el elemento documentado, por ejemplo, una función. Pero en algunos casos, como #define , tiene sentido poner la documentación al final de la línea y, en ese caso, se necesita el marcador /**< .
Las pautas de los códigos C de mis equipos escriben que sería mejor colocar un ''<'' en un comentario como se muestra a continuación:
#define MAX_PACK_ITEM_NUM 50 /**< max number of item */
Me pregunto, ¿cuál es el uso real de este ''<''?
Es una here para comentar a los miembros después de la declaración / definición.
Es una forma para que doxygen genere documentación para los miembros de un archivo / struct / union / class / enum. Al usar ese marcador, puedes poner comentarios después de cada miembro, lo que lleva a menos desorden. Puedes leer más sobre esto here .
Supongo que su equipo utiliza alguna herramienta de documentación automatizada que busca /**< ; Ej. Doxygen .