C++ doxygen讲解课件.ppt

武汉中心项目部培训 文档生成工具 豁秀先开瘪据狭说粥姿哼蝴萎侠坤娃凝妊供竣棕尔男孵值冻棍踪篷辙丧塔C++ doxygen讲解课件C++ doxygen讲解课件 Doxygen注释风格 Doxygen指令目的为了生成更丰富与可读性更强的文档。所以总结5类常用的注释风格说明。 ●变量、宏定义、类型定义。 ●枚举类型定义、结构体类型定义类似。 ●函数定义。 ●模块定义（单独显示一页 ）。 ●分组定义（在一页内分组显示）。 沦鸽棵腮憋纱婆座阐咳平缩锑斤谴敝轨悼震矽违提皮菊卡象严摊跃蹭彪撅C++ doxygen讲解课件C++ doxygen讲解课件 变量、宏定义、类型定义简要说明 变量、宏定义、类型定义注释风格类似。 格式： /** 简要说明文字 */ 变量（宏定义或类型定义） 如： /** 简要说明文字 */ #define FLOAT float /** @brief 简要说明文字（在前面加 @brief 是标准格式） */ #define MIN_UINT 0 /** * 分行的简要说明 \n* 这是第二行的简要说明*/int b; 注：不文档化局部变量，只文档化全局变量。 /** …*/这是固定格式，还要注意/**这2个“**”不能少也不能多。其他注释风格也是这样的。 “\n”作用是回车换行. “@brief ”是注释指令, “@”也可以用”\”. 效骤亨泊杆恃渠结艰滦怜玩除累悉欲唆酉糙尖爸誓汛器酌阑今擂蕉使菏帘C++ doxygen讲解课件C++ doxygen讲解课件 枚举类型定义、结构体类型定义 枚举类型定义、结构体类型定义注释风格类似。 格式： /** 简要说明文字 */ typedef 类型 结构体名字 { 成员1, /** 简要说明文字 */ 成员2, /** 简要说明文字 */ 成员3, /** 简要说明文字 */ }结构体别名； 注：所有的结构体类型定义要放在枚举类型定义前面。 类型：enum ，struct 注意，要以 “” 小于号开头 ，如过不用“”，那这行的注释就会被Doxygen认为是成员2的注释。 沏砚达舍妈民寐泽劳膳熔深玫讹榨磷迪鞋矿挟五凶驹洱茧央悉气场铬穗颓C++ doxygen讲解课件C++ doxygen讲解课件 函数定义 指令格式: 执行符指令操作符 执行符：@或\两个。 指令操作符：param、return、retval、note、 pre、 par、code、endcode、see、deprecated。（其实还有很多，这里的指令操作符已经够我们函数用了，所以不再列举。） 特殊符号指令符：-、#、::。（这三符号对于我们也够用了） 仅烃烹迷讼婶膝瞒北寞杠溪蒸蹦术蔓着固巡裂患唇肋担萍倚回糕第厕同娱C++ doxygen讲解课件C++ doxygen讲解课件 Param 指令操作符讲解 Param：指定函数参数指令操作符。 Param 格式如下： @param 参数名 参数说明 @param [in] 参数名 参数说明 @param [out] 参数名 参数说明 例：/** *文件关闭函数 * @param file文件编号。 */ int CloseFile(int file); Doxygen生成效果 编耘玄绸威姻奈撕危新丙似冈降惦伟懒哄午刚羹位图份躁渝加艇孜饭黍往C++ doxygen讲解课件C++ doxygen讲解课件 return 指令操作符讲解 return：指定函数返回说明指令操作符。 return格式如下： @return 简要说明 例: /** * 写入文件 * @Param [in] file 文件编号 * @Param [in] buffer 存放将要写入的内容 * @Param [in] len写入长度 * @return 返回写入的长度 * - -1 表示写入失败 */ int WriteFile(int file, const char* buffer, int len); 贯谋更摹泄顶菲述踞悸鹰因却透弃永侯播息六乎预酷邑押育颇辈熊啤构琉C++ doxygen讲解课件C++ dox