C++ doxygen讲解.ppt

武汉中心项目部培训 文档生成工具 Doxygen注释风格 Doxygen指令目的为了生成更丰富与可读性更强的文档。所以总结5类常用的注释风格说明。 ●变量、宏定义、类型定义。 ●枚举类型定义、结构体类型定义类似。 ●函数定义。 ●模块定义（单独显示一页 ）。 ●分组定义（在一页内分组显示）。 变量、宏定义、类型定义简要说明 变量、宏定义、类型定义注释风格类似。 格式： /** 简要说明文字 */ 变量（宏定义或类型定义） 如： /** 简要说明文字 */ #define FLOAT float /** @brief 简要说明文字（在前面加 @brief 是标准格式） */ #define MIN_UINT 0 /** * 分行的简要说明 \n* 这是第二行的简要说明*/int b; 注：不文档化局部变量，只文档化全局变量。 枚举类型定义、结构体类型定义 枚举类型定义、结构体类型定义注释风格类似。 格式： /** 简要说明文字 */ typedef 类型 结构体名字 { 成员1, /** 简要说明文字 */ 成员2, /** 简要说明文字 */ 成员3, /** 简要说明文字 */ }结构体别名； 注：所有的结构体类型定义要放在枚举类型定义前面。 函数定义 指令格式: 执行符指令操作符 执行符：@或\两个。 指令操作符：param、return、retval、note、 pre、 par、code、endcode、see、deprecated。（其实还有很多，这里的指令操作符已经够我们函数用了，所以不再列举。） 特殊符号指令符：-、#、::。（这三符号对于我们也够用了） Param 指令操作符讲解 Param：指定函数参数指令操作符。 Param 格式如下： @param 参数名 参数说明 @param [in] 参数名 参数说明 @param [out] 参数名 参数说明 例：/** *文件关闭函数 * @param file文件编号。 */ int CloseFile(int file); return 指令操作符讲解 return：指定函数返回说明指令操作符。 return格式如下： @return 简要说明 例: /** * 写入文件 * @Param [in] file 文件编号 * @Param [in] buffer 存放将要写入的内容 * @Param [in] len写入长度 * @return 返回写入的长度 * - -1 表示写入失败 */ int WriteFile(int file, const char* buffer, int len); retval指令操作符讲解 retval：指定函数返回值说明指令操作符。(注:更前面的return有点不同.这里是返回值说明) retval格式如下： @retval 返回值 简要说明 例: /** *文件关闭函数 * @param file文件编号。 * @retval 0 表示成功 * @retval -1 表示失败 */ int CloseFile(int file); note 指令操作符讲解 note：指定函数注意项事或重要的注解指令操作符。 note格式如下： @note 简要说明 例: /** *打开文件函数 *@Param [in] name 文件名 *@Param [in] “rb” 打开模式 *@return 返回文件编号 *- -1表示打开文件失败 *@note 文件打开成功后,必须使用 CloseFile 函数关闭 */ int OpenFile(U8* file_name, U8* file_mode); pre 指令操作符讲解 pre：指定函数前置条件指令操作符 pre格式如下：