注释中@的含义

Question

我有一个头文件。该文件充满了多行注释。在评论中，很多时候出现一些带有@的单词，例如

/** @that


*/

现在，此“ that”颜色从绿色更改为橙​​色（在Keil IDE中）。这些评论似乎没有任何影响。更改此文本的颜色背后有什么重要意义吗？还是这是我不知道的评论的另一件事，它是无害的？请注意，当我移除“ that”后面的一颗星时，它的颜色也会变为绿色。

Answer 1

您不会在头文件中看到它，因为它与 文档 有关。

它不是C语言本身的一部分，例如使用/*进行注释，但是在大多数情况下，它用于注释函数或/和（根据您的情况）参数

示例：

/**
 * @annotateThatFunctionAsInvokable
 * Add two integers
 *
 * @param   [in]    a    first addend
 * @param   [in]    b    second addend
 * @param   [out]   sum of 'a' and 'b'
*/
void add(int a, int b);

---

注意：C预处理程序几乎ignores的内容是注释，因此任何注释将仅由文档工具考虑。

PS：Doxygen是一种使用广泛的文档工具，为了理解您的文档并正确解析它，请使用这些@。