为什么C评论喜欢/ * * /需要'＆lt;'？

Question

我的团队C代码指南写道，放置'＆lt;'会更好在如下所示的评论中：

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

我想知道，这个'＆lt;'的实际用途是什么？ ？

Answer 1

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

Answer 2

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

• doxygen以＃{1}}开头的普通评论被忽略。
• 以/*开头的评论被视为源代码中评论后下一项的文档。
• 以/**开头的评论被视为源代码中评论之前项目的文档。

文档主要位于记录的项目之上，例如：一个功能。但在某些情况下，例如/**<，将文档放在行的末尾是有意义的，在这种情况下，需要#define标记。

Answer 3

在声明/定义之后评论成员是doxygen syntax。

Answer 4

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