C/C++:注释“/*< */”代表什么?

drd*_*hin 5 c c++ comments doxygen

我有一个相当普遍的问题:我最近在 C/C++ 代码中看到许多#defines 被注释为“/*< ... */”,例如:

#define ARRSIZE(x)          (sizeof(x)/sizeof(x[0]))        /*< macro to determine the size of an array */
Run Code Online (Sandbox Code Playgroud)

我个人只在定义的评论中看到这一点,谷歌搜索也没有回答我的问题。那有什么意义吗?这只是常见的做法还是来自 Doxygen?还是有其他原因?

L. *_* F. 9

一般来说, <是 Doxygen 的语法,用于在他们记录的项目之后出现的文档。

Doxygen 文档的“将文档放在成员之后”部分的示例:

int var; /**< Detailed description after the member */
Run Code Online (Sandbox Code Playgroud)

不过,对您给出的示例感到好奇的是,它使用普通注释块 ( /*) 而不是文档块(例如,/**)。我怀疑这是这个特定示例的作者的疏忽。或者,作者可能将此约定从文档块扩展到所有性质相似的注释。

  • @drdolphin 是的。或者一些有创意的代码编写者喜欢用 ASCII 艺术来装饰评论(忽略 Doxygen 用户可能会偶然发现这一点,甚至不知道文档生成器)。我承认我有时会在代码中写入“// &lt;-- 这里发生了非凡的事情。”之类的注释。;-) (2认同)