C语言@param

@param[in] 是一种常见于 文档注释 中的标记，尤其是在使用 Doxygen 这样的文档生成工具时。它并不是 C 语言语法的一部分，而是用于帮助生成清晰的 API 文档。

含义解释

• @param：表示对函数参数的说明。
• [in]：表示这个参数是输入参数（input），即函数使用这个参数的值，但不会修改它或通过它返回值。

  /**
   * @brief 计算两个整数的和
   * @param[in] a 第一个整数
   * @param[in] b 第二个整数
   * @return 两个整数的和
   */
  int add(int a, int b);

  这个注释说明了：

• 函数 add 的作用是计算两个整数的和。
• 参数 a 和 b 是输入参数。
• 函数返回它们的和。

  标记    含义
  @param[in]    输入参数
  @param[out]    输出参数（函数会修改它）
  @param[in,out]    输入输出参数（函数会读取并修改）
  @return    函数返回值的说明
  @brief    简要描述函数或结构体的作用