中恒诚信建设有限公司网站,怎么做网页关联小程序,安徽建工集团网站,如何创建自己的个人网站利用Doxygen为C程序生成注释文档一、Doxygen工具的安装利用Doxygen工具生成API帮助文档需要下载安装以下三个软件#xff1a;(1)Doxygen#xff1a;可以从一套归档源文件开始#xff0c;生成HTML格式的在线类浏览器#xff0c;或离线的LATEX、RTF参考手册。本文中所使用的版… 利用Doxygen为C程序生成注释文档一、Doxygen工具的安装利用Doxygen工具生成API帮助文档需要下载安装以下三个软件(1)Doxygen可以从一套归档源文件开始生成HTML格式的在线类浏览器或离线的LATEX、RTF参考手册。本文中所使用的版本为Doxygen-1.8.18.(2)Htmlhelp该软件可以帮助您建立 HTML 格式的 HELP 文件。用于创建.chm文件可以从微软官方网站下载。(3)Graphviz是一个由ATT实验室启动的开源工具包用于绘制DOT语言脚本描述的图形与Doxygen配合使用用于提取函数之间头文件之间的调用关系本文中所使用的版本为:graphviz-2.38。二、Doxygen工具的配置1.打开Doxygen软件如下图所示进行工程设置2.模式设置如下图所示3.设置输出格式如下图所示4.设置函数调用配置如下图所示5.输出文档字符集配置6.Build页面这个页面比较关键(1)EXTRACT_ALL输出所有的函数但是private和static函数不属于其管制。(2)EXTRACT_PRIVATE输出private函数。(3)EXTRACT_STATIC输出static函数。(4)SHOW_INCLUDE_FILES 是否显示包含文件如果开启帮助中会专门生成一个页面里面包含所有包含文件的列表。(4)INLINE_INFO 如果开启那么在帮助文档中inline函数前面会有一个inline修饰词来标明。(5)SORT_MEMBER_DOCS 如果开启那么在帮助文档列表显示的时候函数名称会排序否则按照解释的顺序显示。(6)GENERATE_TODOLIST 是否生成TODOLIST页面如果开启那么包含在todo注解中的内容将会单独生成并显示在一个页面中其他的GENERATE选项同。(7)SHOW_USED_FILES 是否在函数或类等的帮助中最下面显示函数或类的来源文件。(8)SHOW_FILES 是否显示文件列表页面如果开启那么帮助中会存在一个一个文件列表索引页面。7.Input选项设置对源文件的编码进行设置设置的编码格式应与源文件的编码格式相同如果源文件不是UTF-8编码需要对源文件进行转换一下否则生成的帮助文档会出现中文乱码现象。8.Source Browser设置9.chm配置10.配置Grapviz11.运行Doxygen三、Doxygen注释格式1.文件注释文件注释是源代码文件进行注释包含源文件和头文件文件注释位于文件的开头。主要包含以下内容文件名(file )作者(author)版本(version)日期(date)和简要说明(brief)还可以包含详细描述(details)版权(copyright)注意(attention)等。2.函数注释函数注释是对本函数进行说明位于函数定义上方。函数注释主要包含以下内容简要说明(brief)参数说明(param)函数返回值情况(return)函数返回值类型(retval)3.宏定义类型的注释4.结构体和枚举类型定义结构体注释枚举类型注释5.项目注释主要对本项目进行简单描述通常位于main.c主函数文件头部。注释为/**mainpage */。主要包含项目名称、功能描述、项目详细描述、用法描述和软件更新记录等。四、Doxygen常用的注释命令1.author 作者信息2.brief 简要说明概要信息3.bug 被标记的代码会在Bug列表中出现4.class 对类进行标注5.data 日期6.file 文件名7.param 主要用于函数说明对参数进行说明8.return 描述函数的返回值情况9.retval 描述函数返回值类型10.note 注解11.attention 注意12.name 分组名13.warning 警告信息14.enum 引入了某个枚举15.var 引入了某个变量16.exception 可能产生的异常描述17.todo 对将要做的事情进行注释18.see 一段包含其他部分引用的注释中间包含对其他代码项的名称自动产生对其的引用链接19.relates 通常用做把非成员函数的注释文档包含在类的说明文档中20.since 从哪个版本后开始有这个函数的21.code 在注释中开始说明一段代码直到endcode结束22.endcode 在注释中代码段的结束23.remarks 备注24.pre 说明代码项的前提条件25.post 说明代码项之后的使用条件26.deprecated 这个函数可能会在将来的版本中取消27.defgroup 模块名 { 模块开始 } 模块结束28.version 版本号29.par 开始一个段落30.detail 详细描述
