- 1、本文档共40页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
专家(Expert)模式 专家(Expert)对话框----Input相关选项 指定输入源文件目录(INPUT). 输入文件编码(INPUT_ENCODING)改为GBK. 对文件过滤选项,我们这里只填*.c *.h. 专家(Expert)模式 专家(Expert)对话框----Messages相关选项 可以通过参数HTML_HEADER和HTML_FOOTER定制页面,参数值是包含定制内容的文件名.这里我填了html_foot 文件,内可以打开html_foot 文件看. 这里只看效果图:如图2. 选择GENERATE_HTMLHELP后,Doxygen会准备生成chm文件需要的项目文件、目录文件和索引文件。 图2 THANK YOU SUCCESS * * 可编辑 专家(Expert)模式 专家(Expert)对话框----Dot相关选项 可以选上UML_LOOK、CALL_GRAPH和CALLER_GRAPH。CALL_GRAPH是本函数调用其它函数的示意图.效果如:图3. 图3 Doxygen注释风格 Doxygen指令目的为了生成更丰富与可读性更强的文档。所以总结5类常用的注释风格说明。 ●变量、宏定义、类型定义。 ●枚举类型定义、结构体类型定义类似。 ●函数定义。 ●模块定义(单独显示一页 )。 ●分组定义(在一页内分组显示)。 变量、宏定义、类型定义简要说明 变量、宏定义、类型定义注释风格类似。 格式: /** 简要说明文字 */ 变量(宏定义或类型定义) 如: /** 简要说明文字 */ #define FLOAT float /** @brief 简要说明文字(在前面加 @brief 是标准格式) */ #define MIN_UINT 0 /** * 分行的简要说明 \n* 这是第二行的简要说明*/int b; 注:不文档化局部变量,只文档化全局变量。 /** …*/这是固定格式,还要注意/**这2个“**”不能少也不能多。其他注释风格也是这样的。 “\n”作用是回车换行. “@brief ”是注释指令, “@”也可以用”\”. 枚举类型定义、结构体类型定义 枚举类型定义、结构体类型定义注释风格类似。 格式: /** 简要说明文字 */ typedef 类型 结构体名字 { 成员1, /** 简要说明文字 */ 成员2, /** 简要说明文字 */ 成员3, /** 简要说明文字 */ }结构体别名; 注:所有的结构体类型定义要放在枚举类型定义前面。 类型:enum ,struct 注意,要以 “” 小于号开头 ,如过不用“”,那这行的注释就会被Doxygen认为是成员2的注释。 函数定义 指令格式: 执行符指令操作符 执行符:@或\两个。 指令操作符:param、return、retval、note、 pre、 par、code、endcode、see、deprecated。(其实还有很多,这里的指令操作符已经够我们函数用了,所以不再列举。) 特殊符号指令符:-、#、::。(这三符号对于我们也够用了) Param 指令操作符讲解 Param:指定函数参数指令操作符。 Param 格式如下: @param 参数名 参数说明 @param [in] 参数名 参数说明 @param [out] 参数名 参数说明 例:/** *文件关闭函数 * @param file文件编号。 */ int CloseFile(int file); Doxygen生成效果 return 指令操作符讲解 return:指定函数返回说明指令操作符。 return格式如下: @return 简要说明 例: /** * 写入文件 * @Param [in] file 文件编号 * @Param [in] buffer 存放将要写入的内容 * @Param [in] len写入长度 * @return 返回写入的长度 * - -1 表示写入失败 */ int WriteFile(int file, const char* b
文档评论(0)