doxygen 生成注释文档

下载工具doxygen ，https://www.doxygen.nl/download.html

文件头部注释

/** @file func.h */
#ifndef __FUNC_H__
#define __FUNC_H__
/**
 * @file func.h
 * @brief 用于测试 doxygen 生成文档
 * @details 示例一个 sqrt 函数
 */

函数注释

/**
 *   @brief 求一个数的平方根
 *   @details 二分逼近法求平方根
 *   @param a 大于 0 的整数
 *   @param[out] res 是输出参数，用于保存sqrt运算的结果
 *   @return 大于0 成功，小于等于0失败
 *   @retval = 0   系统错误
 *   @retval = -1  参数错误
 *   @todo 增加打印
 */
int mysqrt(int a, double *res);

结果

图片.png

其他一些说明：

/** 缓存大小，上方注释  */
#define BUFSIZ 1024*4 ///< 缓存大小2，下方注释 

/**
 * @brief 长方形结构体
 * 
*/
typedef struct Rect
{
    int x; ///< x 坐标位置
    int y; ///< y 坐标位置
    int width; ///< 矩形宽度
    int height; ///< 矩形高度
}Rect;