Doxygen代码注释规范.doc

发布时间：2022-05-29 发布人：admin 分类：说明书资料大小：1.50M 资料格式：doc 举报版权申诉

huiuztao154-8429217-4744300845226976560.doc.pdf-第1页.png

第1页 / 共24页

huiuztao154-8429217-4744300845226976560.doc.pdf-第2页.png

第2页 / 共24页

huiuztao154-8429217-4744300845226976560.doc.pdf-第3页.png

第3页 / 共24页

huiuztao154-8429217-4744300845226976560.doc.pdf-第4页.png

第4页 / 共24页

huiuztao154-8429217-4744300845226976560.doc.pdf-第5页.png

第5页 / 共24页

huiuztao154-8429217-4744300845226976560.doc.pdf-第6页.png

第6页 / 共24页

huiuztao154-8429217-4744300845226976560.doc.pdf-第7页.png

第7页 / 共24页

huiuztao154-8429217-4744300845226976560.doc.pdf-第8页.png

第8页 / 共24页

基于Doxygen的代码注释规范

一、Doxygen系列软件介绍

1、Doxygen

2、graphviz

3、HTML Help WorkShop

二、软件下载与安装

三、软件配置使用

四、Doxygen注释规范简介

1、Doxygen规范综述

2、Doxygen常用指令

3、Doxygen注释实例

基于 Doxygen 的代码注释规范

一、Doxygen 系列软件介绍 1、Doxygen Doxygen 是一种开源跨平台的，以类似 JavaDoc 风格描述的文档系统，完全支持 C、C++、Java、Objective-C 和 IDL 语言，部分支持 PHP、C#。注释的语法与 Qt-Doc、KDoc 和 JavaDoc 兼容。Doxgen 可以从一套归档源文件开始，生成 HTML 格式的在线类浏览器，或离线的 LATEX、RTF 参考手册。 Doxygen 能将程序中的特定批注转换成为说明文件。它可以依据程序本身的结构，将程序中按规范注释的批注经过处理生成一个纯粹的参考手册，通过提取代码结构或借助自动生成的包含依赖图（include dependency graphs）、继承图（inheritance diagram）以及协作图（collaboration diagram）来可视化文档之间的关系， Doxygen 生成的帮助文档的格式可以是 CHM、RTF、PostScript、 PDF、HTML 等。 2、graphviz Graphviz(Graph Visualization Software)是一个由 AT&T 实验室启动的开源工具包,用于绘制 DOT 语言脚本描述的图形。要使用 Doxygen 生成依赖图、继承图以及协作图，必须先安装 graphviz 软件。 3、HTML Help WorkShop 微软出品的 HTML Help WorkShop 是制作 CHM 文件的最佳工具，它能将 HTML 文件编译生成 CHM 文档。 Doxygen 软件默认生成 HTML 文件或 Latex 文件，我们要通过 HTML 生成 CHM 文档，需要先安装 HTML Help WorkShop 软件，并在 Doxygen 中进行关联。

二、软件下载与安装 Doxygen 下载（doxygen-1.8.7-setup.exe）： http://www.stack.nl/~dimitri/doxygen/download.html graphviz（for windows）下载： http://www.graphviz.org/Download..php HTML Help WorkShop（1.32）下载： http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe 软件安装都选择默认方式，点击下一步直至安装完成。安装完后进行 Doxygen 配置时需要关联 graphviz 和 HTML Help WorkShop 的安装路径。三、软件配置使用我们的所有配置都在 Doxywizard 中进行，生成参考手册是通过运行 Doxywizard 得到。（1）Wizard->Project 最重要的是工作目录，源代码目录，生成参考文件目录三处的设定，其它项目名称、项目简介、版本和标识可以依照实际情况选填。工作目录是新建的一个目录，在配置完成之后可以把配置文件存在这个目录里，每次从这个目录中导入配置文件（.cfg），然后进行说明文档生成。源代码目录和最终的结果目录在每一次运行 Doxywizard 时都进行设定。

（2）Wizard->Mode 选择编程语言对应的最优化结果，按照编程语言选择。（3）Wizard->Output 选择输出格式，选 HTML 下的（.chm）项，为最后生成 chm 做准备。由于不需要 LaTeX 结果，不选此项。

（4）Wizard->Diagrams 选择 dot tool 项，通过 GraphViz 来作图。（5）Expert-> Project 选择输出目录，选着输出语言。如果代码中采用了中文注释，此处选择为中文。

向下拉滑条，看见有 JAVADOC_AUTOBRIEF 和 QT_AUTOBRIEF 两个框，如果勾选了，在这两种风格下默认第一行为简单说明，以第一个句号为分隔；如果不选，则需要按照 Doxygen 的指令@brief 来进行标准注释。（6）Expert-> Input 将输入编码方式改为 GBK 方式，确保输出中不会由于 UTF-8 方式导致乱码。

最后也是经常遇到的问题就是 DoxyGen 生成的 CHM 文件的左边树目录的中文变成了乱码。这个只需要将 chm 索引的编码类型修改为 GB2312 即可。在 HTML 的 CHM_INDEX_ENCODING 中输入 GB2312 即可。（ 7 ） Expert-> HTML 勾选生成 HTMLHELP 项，输入生成 CHM 名称，在 HHC_LOCATION 中填入 HTMLHELP WORKSHOP 安装目录中 hhc.exe 的路径，将 chm 编码方式改为 GBK 方式，与第（6）步中的输入编码方式一致。（8）Expert->Dot 在 Dot_PATH 中填写 GraphViz 的安装路径。

需要在 build 中配置 EXTRACT_ALL 和 LOCAL_METHODS 才能生成所有的变量和函数。（9）存储配置信息。到上一步 Doxygen 已经完全配置好，可以在 Run 中点击运行了，但为了保存以上配置信息，可以将配置好的文件存一个.cfg 文件，之后再运行 Doxygen 时只需要将该文件用 Doxygen 打开，改变第（1）步中的输入、输出目录及工程的信息再运行。

分享到：

赞收藏

资料库

Doxygen代码注释规范.doc

相关推荐

开发技术

热门标签

最新资料