Pourquoi un commentaire C comme / * * / nécessite-t-il '<'?

Question

Les directives de mon équipe en matière de code C écrivent qu'il serait préférable de placer un '<' dans un commentaire comme indiqué ci-dessous:

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

Je me demande quelle est l'utilisation réelle de ce '<'?

Answer 1

C'est un moyen pour doxygen de générer de la documentation pour les membres d'un fichier / struct / union / class / enum. En utilisant ce marqueur, vous pouvez ajouter des commentaires après chaque membre, ce qui réduit l'encombrement. Vous pouvez en lire plus à ce sujet ici .

Answer 2

Comme d'autres ont répondu, c'est probablement un commentaire qui est destiné à doxygen. Lors de l'analyse des commentaires, doxygen ont certaines règles spéciales:

• Ordinaire commentaire commençant par /* est ignoré par doxygen.
• Un commentaire commençant par /** est traité comme de la documentation de l' élément suivant après le commentaire dans le code source.
• Un commentaire commençant par /**< est traité comme de la documentation de l'élément immédiatement avant le commentaire dans le code source.

La Documentation est principalement placé au-dessus de la documentation de l'élément, par exemple une fonction. Mais dans certains cas comme un #define il est logique de mettre la documentation à la fin de la ligne la place, et dans ce cas, l' /**< marqueur est nécessaire.

Answer 3

C'est une syntaxe doxygen pour commenter les membres après la déclaration / définition.

Answer 4

Je suppose que votre équipe utilise un outil de documentation automatisé qui recherche /**< ; par exemple Doxygen .