DOXYGEN注释宏使用步骤及常见问题解决方法
来源:互联网 发布:python 时间序列模型 编辑:程序博客网 时间:2024/05/16 19:49
步骤1 :下载doxygen的binary 包
doxygen下载地址
http://www.10.xdowns.com/uploadFile/2007-7/doxygen.rar
为了使doxygen能够将类图、协作图等 加入到文档中,还要下载安装graphviz for win。
graphviz 2.18下载:
http://www.graphviz.org/pub/graphviz/ARCHIVE/graphviz-2.18.exe
全部安装后就可以开始使用了。
步骤2:运行doxygen wizard.exe
如果你像我一样希望只通过图形界面运行doxygen的话,请在doxygen的bin目录中运行doxywizard.exe,这时按照doxygen根目录下的文档(doxygen_manual-1.5.2.chm)中 Doxywizard usage一节的说明设置即可。主要包括,源码路径、工作路径、输出路径等。
步骤3:点开始,即可生成文档
最后对文档生成过程中遇到的一些问题进行说明:
1.中文问题:中文注释在文档中是乱码。
解决:在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”,这样基于GB的文本编辑器生成的代码就可以正常使用了。
但是,还有一个无法彻底解决的问题就是,当输出语言为中文时左边的导航栏的所有中文仍然是乱码。哪位有解决方案,请务必告知!
2.图形问题:无法绘制类图协作图等图形。
解决:首先确保安装了graphviz for win,注意不是wingraphviz,后者是一个graphviz的com封装,但是doxygen并不是基于它开发的,所以装了也没用。然后在expert的DOT_PATH中填入graphviz的安装路径。接着在wizard的diagram中选择需要生成的图形类别就可以了。
如果出现无法包含.map文件的错误,可以将工作目录设置成html,并将html中所有文件都清除再试。这个问题的原因还不太确定。
3.输出chm的问题:如何输出.chm文件
在expert中的HTML页:选中“GENERATE_HTMLHELP”,然后在CHM_FILE中填上想要的chm文件名。
HHC_LOCATION中输入hhc.exe文件的路径。hhc.exe可以通过安装HTML Help Workshop获得。
HTML Help Workshop 地址:
http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
这样,基本上就能够用doxygen生成漂亮的文档了。代码方面,doxygen支持多种格式的注释风格,根据manual选择自己喜欢的就好。
乱码:
导航栏的所有中文仍然是乱码的原因是你只指明了 INPUT_ENCODING =GB2312,另外还得在Expert..的第一项Project中指明DOXYFILE ENCODING = GB2312,OUTPUT_LANGUAGE = Chinese
- DOXYGEN注释宏使用步骤及常见问题解决方法
- Doxygen C++注释规范及生成帮助文档配置步骤
- 使用DOXYGEN风格注释
- 使用 doxygen 写注释
- scanf使用常见问题及解决方法
- Doxygen安装版使用步骤
- Doxygen使用学习(一)------Doxygen的简单注释格式
- 使用Resin 4最常见问题及解决方法
- oozie使用中常见问题及解决方法
- Ubuntu Ubuntu使用经验,常见问题及解决方法
- Office电脑使用常见问题及解决方法
- doxygen注释
- doxygen注释
- xcode中使用Doxygen快速生成注释
- doxygen使用与C++注释规范
- SAP常见问题及解决方法
- Ext常见问题及解决方法
- Silverlight常见问题及解决方法
- 编程修养
- 转换字符(就是%后跟的部分)
- CString/string 区别及其转化
- 好久没有更新了,该好好总结一下最近做过的开发了~~~
- String类的实现
- DOXYGEN注释宏使用步骤及常见问题解决方法
- SIP和ISUP协议互通的研究
- CString ,BSTR ,LPCTSTR之间关系和区别
- 【从黑盒到灰盒】我的第一个shell脚本
- RMI介绍
- GetCurrentProcessID、OpenProcessToken
- 一个有意思的数学知识网站
- OpenGL的坐标轴
- 浅析Windows的开始->运行