|
以前没有认识到代码注释的重要性,后来再次拿回以前的程序来看时,看得很费劲,因为以前每写一个文件就一种注释风格。 在网上找了一下自动生成代码文件的软件,发现Doxygen这个软件挺好的。
于是在网上找了些资料,一边操作,一边记录下来,以下贴上我记录下来的一些文档,希望对大家有用。
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来编译Doxygen生成的html文件夹中的.hhp文件,编译完成后即可在该html文件夹中找到对应的chm文件。
4 Doxygen无法为DLL中定义的类 导出文档。
例如:
class __declspec(dllexport) CClassName:public CObject
{}
目前发现Doxygen无法识别出DLL中定义的类。
5 如何修改或者去掉右下脚Generated at Doxygen的文字?
打开[Expert...]的HTML页面,然后在HTML_FOOTER中指定相应的HTML文件即可。注意HTML_FOOTER中至少包含BODY 和HTML结束标记。即一个最小的尾部HTML至少是这样</BODY></HTML>。同理,如果你要指定了 HTML_HEADER,他至少包含<HTML><HEAD></HEAD><BODY>。
6 如何在chm文件的索引下显示函数列表?
打开[Expert...]的HTML页面,然后选中TOC_EXPAND即可。
7 如何在chm文件的函数说明中屏蔽源码的信息和链接?
打开[Expert...]的Source Browser页面,然后将”SOURCE_BROWSER”选项的钩去掉。
全部资料51hei下载地址:
|
-
-
Doxygen Expert专家模式配置.docx
216.51 KB, 下载次数: 6, 下载积分: 黑币 -5
-
-
Doxygen Wizard模式配置.docx
208.89 KB, 下载次数: 6, 下载积分: 黑币 -5
-
-
Doxygen的注释风格.docx
39.97 KB, 下载次数: 6, 下载积分: 黑币 -5
-
-
Doxygen使用的常见问题小结.docx
56.89 KB, 下载次数: 7, 下载积分: 黑币 -5
-
-
Doxygen支持的指令.docx
15.02 KB, 下载次数: 5, 下载积分: 黑币 -5
|