是＆＃39; @＆＃39; character在评论中有任何意义吗？

Question

我从编码示例中复制了一个文件，其中包含以下注释：

/ ** @addtogroup CMSIS   * @ {   * /

/ ** @addtogroup stm32f30x_system   * @ {   * /

/ ** @addtogroup STM32F30x_System_Private_Includes   * @ {   * /

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

Answer 1

\addtogroup或@addtogroup是doxygen command。

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

Answer 2

有一种叫做“伪评论”的东西。它们是在C之前介绍的。源代码不仅由编译器处理。其他程序也可以阅读它。这些是格式化程序，缺陷的静态检查程序，公司样式的检查程序，接口提取程序等。通常情况下，他们想要了解有关代码的更多信息。将这些附加信息传达给这些工具的最简单方法是评论。这些程序会查找具有特定形式的注释，这些注释显然特定于每个工具。上面的氧气就是一个很好的例子。还有很多其他工具需要其他特殊格式的评论。

底线：

• 只有在使用时才需要工具“Blah”的伪注释 （或期望使用）此工具。否则，特别是如果您不确定它们的含义，最好删除它们。
• 您可以放心地假设编译器忽略任何注释的内容。好吧，除了非常罕见的情况，编译器的文档说明相反。