C语言注释-文档注释/**

在 C 语言中，文档注释（Documentation Comments）通常是为了生成自动化文档而写的，最常见的工具是 Doxygen。Doxygen 是一个可以从注释中提取信息并生成 HTML、LaTeX、PDF 等格式文档的工具。

---

 文档注释的基本格式（Doxygen 风格）

Doxygen 支持多种注释风格，最常见的是：

/**
 * @brief 简要描述函数的作用
 * @param[in] 参数名 参数的用途
 * @param[out] 参数名 函数会修改的参数
 * @param[in,out] 参数名 输入输出参数
 * @return 返回值的说明
 */

 示例：带文档注释的 C 函数

#include <stdio.h>

/**
 * @brief 计算两个整数的最大值
 *
 * 该函数比较两个整数并返回其中较大的一个。
 *
 * @param[in] a 第一个整数
 * @param[in] b 第二个整数
 * @return 返回 a 和 b 中较大的值
 */
int max(int a, int b) {
    return (a > b) ? a : b;
}

常用 Doxygen 标记

记	说明
@brief	简要描述函数或结构体的作用
@param	描述函数参数
@return	描述函数的返回值
@note	额外说明
@warning	警告信息
@see	参考其他函数或文档
@file	文件级别的说明
@author	作者信息
@version	版本信息