c - @在评论中的意义

Question

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

/** @that


*/

现在这个“那个”的颜色从绿色变为橙色(在 Keil IDE 中)。这些评论似乎没有任何影响。更改此文本的颜色背后是否有任何重要意义？或者这只是我不知道的关于评论的另一件事，它是无害的？请注意，当我删除“that”后面的一颗星时，它也会将颜色更改为绿色。

Answer 1

您在头文件中看到它并非偶然，因为它与文档相关。

它不是 C 语言本身的一部分，例如使用 /* 进行注释，但大多数时候，它用于注释函数，或/和(如在您的case) 一个参数。

例子:

/**
 * @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 ，为了理解您的文档并正确解析它，使用这些 @。