为什么C评论像/ * */need'<'？

Question

我的团队C代码编写的指导方针，它会更好，在注释放置一个“<”如下图所示：

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

我不知道，什么是真正的利用这一“<”？

Answer 1

这是doxygen为文件/结构/联合/类/枚举的成员生成文档的一种方式。通过使用该标记，您可以在每个成员之后发表评论，从而减少混乱。你可以阅读更多关于它here。

Answer 2

我假设你的团队使用一些自动文档工具，它寻找/**<;例如Doxygen。

Answer 3

这是一个doxygen syntax用于在声明/定义后评论成员。

Answer 4

正如其他人已经回复，这可能是一个意见，是为了doxygen。当分析评论，Doxygen的有一些特殊的规则：

• 一个普通的评论开始/*是忽略由doxygen的。
• 以/**开头的评论被视为源代码中评论下一项的文档。
• 以/**<开头的评论被视为之前源代码中的注释的文档。

文档大多放置在记录的项目上方，例如，一个函数。但在某些情况下，例如#define，将文档放在行末是有意义的，在这种情况下，需要使用/**<标记。