C/C++:注释“/*< */”代表什么?
C/C++: What does the comment "/*< */" stand for?
我有一个相当笼统的问题:我最近在 C/C++ 代码中看到许多 #defines 被注释为“/*< ... */”,例如:
#define ARRSIZE(x) (sizeof(x)/sizeof(x[0])) /*< macro to determine the size of an array */
我个人只在定义的评论中看到,Google 中的搜索也没有回答我的问题。那有什么意义吗?这只是常见的做法还是来自 Doxygen?还是其他原因?
通常,<
是 Doxygen 的语法,用于在他们记录的项目之后的文档。
来自 Doxygen 文档 "Putting documentation after members" 部分的示例:
int var; /**< Detailed description after the member */
不过,您给出的示例令人好奇的是,它使用的是普通注释块 (/*
) 而不是文档块(例如 /**
)。我怀疑这是对这个特定示例的作者的疏忽。或者,作者可能将此约定从文档块扩展到所有性质相似的注释。
我有一个相当笼统的问题:我最近在 C/C++ 代码中看到许多 #defines 被注释为“/*< ... */”,例如:
#define ARRSIZE(x) (sizeof(x)/sizeof(x[0])) /*< macro to determine the size of an array */
我个人只在定义的评论中看到,Google 中的搜索也没有回答我的问题。那有什么意义吗?这只是常见的做法还是来自 Doxygen?还是其他原因?
通常,<
是 Doxygen 的语法,用于在他们记录的项目之后的文档。
来自 Doxygen 文档 "Putting documentation after members" 部分的示例:
int var; /**< Detailed description after the member */
不过,您给出的示例令人好奇的是,它使用的是普通注释块 (/*
) 而不是文档块(例如 /**
)。我怀疑这是对这个特定示例的作者的疏忽。或者,作者可能将此约定从文档块扩展到所有性质相似的注释。