你好,游客 登录 注册 搜索
背景:
阅读新闻

怎样生成开源项目源代码的CHM文档 - 晨宇思远

[日期:2013-03-20] 来源:  作者: [字体: ]

目前开源项目越来越多,例如Linux、Android、OpenCV、PCL等等。这些项目代码规模非常大,文件多,要一个个查看费时费力,而且不过类、函数对象之间的调用关系难以直观分析。这里向大家介绍一种通过Doxygen、Graphviz和HTML Help SDK来生成包含代码Call Graph等信息的CHM文档,实现All-in-One的代码阅读与分析。

具体地:

1、在这里下载最新的 Doxygen :
http://www.stack.nl/~dimitri/doxygen/

2、另外还有要下载 Graphviz 和 Microsoft HTML Help SDK :
——Graphviz
http://www.graphviz.org/About.php
——Microsoft HTML Help
http://www.microsoft.com/en-us/download/details.aspx?id=21138

3、安装好上面3个软件后,打开 Doxygen

4、在 Step1 指定Doxygen的工作目录,即最终生成html文件夹和chm文档的路径

5、在 Step2 的标签Wizard 或 Expert 里依次设定各项参数。Wizard标签里是项目的总体关键参数设置,一般设置完Wizard的参数即可生成一个包含代码基本信息的chm文档;如果你需要更全面、更深入的代码分析信息,例如类内部成员函数的Call Graph等等,就要在Expert标签中进行定制。

注:以OpenCV项目(https://github.com/Itseez/opencv)代码为例,第4、5步的设置,可下载我在新浪微盘共享的Doxyfile文件(http://t.cn/zYDKs0l),在Doxygen的file-open中导入该文件,然后修改下图红框处的参数或文件夹路径即可。

6、在标签 Run 点击 Run doxygen,在你指定的输出路径会生成一个 html 文件夹

7、打开 HTML Help Workshop,在 File - Open 里选择上述的 html 文件夹中的 index.hhp 打开,按下图点击Project的Option按钮,在弹出窗口中修改Compiled file到你所需的chm生成路径;然后再点击 File - Compile,这样就可以得到所需的 chm 文档了 O(∩_∩)O~

 

下面是我生成的OpenCV项目代码CHM文档,所用的设置就是上面提到的微盘共享文件,因为设置了对整个项目所有函数对象(包括public/protected/private)的Call Graph都进行分析,生成了大量的图片文件,所以最终得到的CHM文档大小超过了 1.5 G,大家在导入设置文件后、可以试情况在Expert标签中对个别参数进行调整,得到大小适中的CHM文档。





收藏 推荐 打印 | 录入:admin | 阅读:
相关新闻