代码文档生成工具-Doxygen生成CHM和RTF图文教程

Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,可以从一套归档源文件开始,生成chm格式的文档。本文主要讲解如何在winddows下安装doxygen。

1、下载doxygen-1.8.8-setup.exe,下载地址为:

1)官方地址:http://www.stack.nl/~dimitri/doxygen/download.html

2)华军软件:http://www.onlinedown.net/soft/117010.htm

2、下载graphviz,下载地址为:

1)官方地址:http://www.graphviz.org/Download.php (需要注册账号后下载)

2)天空下载:http://www.skycn.com/soft/appid/6971.html

3、下载htmlhelp.exe,下载地址为:

http://msdn.microsoft.com/en-us/library/ms669985.aspx

4、下载后的情况如下:

5、分别安装doxygen、graphviz、htmlhelp,软件安装的过程在此就不再介绍。

doxygen安装完成后我们需要生成chm格式文档,本文将以一个范本为例进行说明如何使用doxygen生成chm的全过程,以供大家学习使用。

1、运行doxygen程序,doxygen图标为

2、Wizard->Project页按照下图进行设置调整参数。

3、Wizard->Mode页按照下图进行设置调整参数。

4、Wizard->OutPut页按照下图进行设置调整参数。

5、Wizard->Diagrams页按照下图进行设置调整参数。

6、Expert>Project页按照下图进行设置调整参数。

7、Expert>Build页按照下图进行设置调整参数。

8、Expert>Input页按照下图进行设置调整参数。

9、Expert>Html页按照下图进行设置调整参数。

10、Expert>Dot页按照下图进行设置调整参数。

11、Run页按照下图进行点击生成chm文件。

12、chm文件生成路径。

13、双击打开PerLib.chm即可查看生产的chm文件内容。

14、到此chm文件生产完毕,为了下次代码调整后再次生产chm文件此时我们可以将目前所做的工作进行保存,点击File->Save,如下图:

15、在弹出对话框中选择保存的路径和名称,本文保存名为Doxyfile

16、保存文件路径为D

17、后期使用可以通过步骤2中的file下的open菜单打开重新调整设置生产新的chm文件

http://blog.sina.com.cn/s/blog_a459dcf50102v7fr.html

http://wenku.baidu.com/view/490e25a2284ac850ad0242c9.html

http://wenku.baidu.com/link?url=Saw0nyOmhBtVdTLrU8mkis1d24tEtrxZZ70B4jC4bulbyqCaVk3CFVmfHJrDtuBtXz8EczkssnttQwaeAxMWVF6OWUVXGyHO7ow9tfY92MO

http://wenku.baidu.com/view/3e85d2d37f1922791688e8ac.html?re=view.

代码文档生成工具-Doxygen生成CHM和RTF图文教程.rar

时间: 2024-12-15 04:48:03

代码文档生成工具-Doxygen生成CHM和RTF图文教程的相关文章

用doxygen+graphviz自动化生成代码文档(附详细教程)

一.引子 用这两个工具可以自动的遍历代码,并且产生代码文档,我们先来看看效果,然后放出这两个工具的下载地址. 二.工具的下载地址 doxygen:http://www.stack.nl/~dimitri/doxygen/download.html graphviz:http://www.graphviz.org/ 三.使用步骤 首先安装doxygen,然后解压下载好的graphviz.接着打开doxygen,按照我下面的图示进行操作就好了. 最后点run就可以了. 附上doxygen能识别的一些

文档生成工具doxygen+图像生成工具GraphViz

文档生成工具doxygen+图像生成工具GraphViz 虽然jdk自带的javadoc也很好用,不过使用doxygen+GraphViz 的组合可以生成许多强大的图(类图.协作图.文件包含/被包含图.函数调用/被调用图.类继承体系图等),另外,doxygen支持直接生成chm文档,支持LaTeX公式,如果你有一个支持php的服务器,生成的html还可以加入一个搜索框. doxygen是开源的C语言软体,可以在它的官方网站上下载到软体和源码:http://www.stack.nl/~dimitr

<整理> 使用Python Sphinx自动生成代码文档

使用Sphinx自动生成代码文档 参考来源: https://blog.csdn.net/sinat_29957455/article/details/83657029 https://www.cnblogs.com/xuzijie/p/9677621.html 欢迎讨论交流,如有侵权请联系本人! 版本信息 Python 3.6.8 :: Anaconda, Inc. Sphinx 1.8.4 前置步骤 安装Python和pip,使用pip安装Sphinx. 在项目目录中创建src文件夹,用来存

使用doxygen制作C代码文档

使用doxygen制作C代码文档 C 代码注释风格约定 行间注释 /*! * * 这里是注释 * */ 行内注释 <code here> /*! 这里是注释 */ doxygen 风格的宏 宏名可以是'\'或'@'后面跟宏名组成.如:\brief 或 @brief 表示一个简要说明在doxygen生成的html中, 前部分显示概要信息, 该信息后有个"更多" ,点击跳转到详细说明. 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏名 宏

数据字典生成工具(生成Excel, Word,PDF,html)

转自:http://www.cnblogs.com/yanweidie/p/3838765.html 数据字典生成工具之旅系列文章导航 数据字典生成工具之旅系列文章导航 宣传语 数据字典生成工具.数据字典文档生成工具.NPOI入门.NPOI下载.NPOI中文教程.NPOI实例.DocX组件操作Word.PowerDesign读取.WORD读取和操作.NVelocity模版文件生成.数据字典生成工具之旅 导游 数据字典生成工具会根据模版文件生成创建表的SQL语句,包含SQL自动提示功能,操作更加快

基于Doxygen_C语言代码文档一键生成的记录与规范(嵌入式适用)

下位机代码格式规范整合记录 注册 doxygen 账号获取doxygen 的 *.exe 执行文件 https://pan.baidu.com/s/1MF5v-Ts80BysmZtXSqONmg 提取码:l4br 进入Graphviz 首页下载Graphviz 软件*.mis 安装包  (可不选,但推荐) https://pan.baidu.com/s/1lIhc31LUvZNVK75r9ghtNA 提取码:12wo 安装.安装完成后: 打开Doxygen GUI frontend ,配置文档格

微软源代码管理工具TFS2013安装与使用详细图文教程(Vs2013)

转:http://blog.csdn.net/gulijiang2008/article/details/41447989 这篇文章联合软件小编主要介绍了微软源代码管理工具TFS2013安装与使用图文教程,本文详细的给出了TFS2013的安装配置过程.使用教程,需要的朋友可以参考下 最近公司新开发一个项目要用微软的TFS2013进行项目的源代码管理,以前只是用过SVN,从来没有用过TFS,所以在网上百度.谷歌了好一阵子来查看怎么安装和配置,还好花了一天时间总算是初步的搞定了,下面就简单介绍一下安

[转] 微软源代码管理工具TFS2013安装与使用详细图文教程(Vs2013)

这篇文章联合软件小编主要介绍了微软源代码管理工具TFS2013安装与使用图文教程,本文详细的给出了TFS2013的安装配置过程.使用教程,需要的朋友可以参考下 最近公司新开发一个项目要用微软的TFS2013进行项目的源代码管理,以前只是用过SVN,从来没有用过TFS,所以在网上百度.谷歌了好一阵子来查看怎么安装和配置,还好花了一天时间总算是初步的搞定了,下面就简单介绍一下安装和配置过程. 一.安装和配置过程介绍 要安装TFS2013当然要先进行下载了,可以在下面的地址下载:http://www.

使用代码辅助生成工具CodeSmith -- 生成NHibernate的映射文件

首先下载CodeSmith工具:在百度云中,在CodeSmith文件夹中. 安装,使用激活工具激活. 然后下载NHibernate模板,也是在百度云中,在CodeSmith文件夹中. 之后直接点击NHibernate中的模板文件. 之后的教程:http://www.2cto.com/database/201408/322382.html