为什么C评论喜欢/**/需要'<'？

Question

我的团队C代码指南写道,最好在注释中放置一个'<',如下所示:

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

我想知道,这个'<'的实际用途是什么？

Answer 1

这是为doxygen文件/ struct/union/class/enum的成员生成文档的一种方法.通过使用该标记,您可以在每个成员之后添加注释,从而减少混乱.你可以在这里阅读更多相关信息.

Answer 2

正如其他人所回答的那样,这可能是一个针对doxygen的评论.在解析注释时,doxygen有一些特殊的规则:

• doxygen /*会忽略以普通注释开头的注释.
• 开头的注释/**被视为源代码中注释后的下一个项目的文档.
• 开头的注释/**<被视为源代码中注释之前的项目的文档.

文档大多位于记录的项目之上,例如函数.但在某些情况下,例如#define将文档放在行尾,而在这种情况下/**<需要标记.

Answer 3

它是一种doxygen语法,用于在声明/定义后对成员进行注释.

Answer 4

我假设您的团队使用了一些自动化的文档工具来寻找/**<; 例如Doxygen.