为什么C的评论像/ * * /需要'<'？

我的团队C代码指导方针写道，最好在如下所示的注释中放置一个“<”：

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

我想知道这个“<”的真正用途是什么？

Answer 1

这是doxygen为文件/结构/联合/类/枚举成员生成文档的一种方法。 通过使用该标记，您可以在每个成员之后放置注释，从而减less混乱。 你可以在这里阅读更多。

Answer 2

正如其他人回答，这可能是一个意见，是为了doxygen。 parsing注释时，doxygen有一些特殊的规则：

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

文档大部分放置在logging的项目之上，例如function。 但是在某些情况下，比如#define ，将文档放在行尾是有意义的，在这种情况下，需要/**<标记。

Answer 3

声明/定义之后，它是用于评论成员的doxygen语法 。

Answer 4

我假设你的团队使用了一些自动化的文档工具来查找/**< 例如Doxygen 。