“@”字符在评论中有任何意义吗?

Does the '@' character have any meaning in comments?

我有一个从编码示例复制的文件,其中包含以下注释:

/** @addtogroup CMSIS * @{ */

/** @addtogroup stm32f30x_system * @{ */

/** @addtogroup STM32F30x_System_Private_Includes * @{ */

我正在为 STM32F303x 使用 C 中的 IAR EWARM 开发环境编码

\addtogroup@addtogroupdoxygen command.

因此,如果您使用 doxygen 从您的代码中生成 API 文档,那么您只想保留这些注释。

有一种东西叫做"pseudo comments"。它们是在 C 之前引入的。源代码不仅由编译器处理。其他程序也可以读取它。这些是格式化程序、缺陷静态检查器、公司风格检查器、接口提取器等。通常情况下,他们想了解有关代码的更多信息。将此附加信息传达给这些工具的最简单方法是注释。这些程序寻找具有特定形式的评论,这显然是针对每个工具的。上面的 Doxygen 就是一个很好的例子。还有大量其他工具需要其他特殊格式的注释。

底线:

  • 只有在使用时才需要工具 "Blah" 的伪注释 (或期望使用)这个工具。否则,尤其是你不清楚它们的意思时,最好删除它们。
  • 您可以安全地假设编译器忽略了任何注释的内容。好吧,除了非常罕见的情况,当你的编译器的文档说相反的时候。