doxygen生成word文档

doxygen生成rtf/word使用小心得
2009-07-26 19:53

       硕士毕业要写个技术文档,蒙了,真麻。怎么也都不行,后来老师给指了条路:使用doxygen。

      网上有许多关于使用doxygen的帖子,不过大都是互相copy(怎么和我的名字很像,我可不是这样的人),再不就是知而不言,言而不尽。不过我觉得来自CSDN的一篇文章很好,是伐木大哥的:使用doxygen为C/C++程序生成中文文档(上),找了好久,就是没有找到(下),可能是他比较忙的原因吧,不过足以让我学一阵儿的了。(还是CSDN的技术贴和博客解渴)

        网络上其他地方的叙述多是照搬伐木大哥的,今天我也不是要重新叙述一遍,而是讲讲我的心得。

       目的:应用doxygen生成rtf/word格式文件。(网上大多是生成chm的,伐木大哥的也是,我在这里就算补充吧)

       心态:虽然doxygen这一套东西弄下来(包括graphviz等)很麻烦,不过软件终究是软件,他不是编程软件,所以我们只是用它们帮忙生成个图或文档,没啥难的,别着急,静下心慢慢来。

       不足:我只会生成英文的,中文的还在学习中(这点就比不上伐木大哥啦*^_^*)

       第一步:摆平Wizard.

                  Project标签:设置你的工程名(Project name)、版本号(ID)、源文件文件夹(Source code directory)、目标文件夹(Destination directory)

                   mode标签:选语言啊,别忘了,别的没啥。

                  Output标签:我这里是生成rtf/word的,就不勾HTML和LaTeX了。

                  其他默认。

        第二步:搞定Expert.

                  许多朋友是卡在这里了。

                  Project标签:其和Wizard的差不多,语言我选的是English,DOXYFILE_ENCODING默认为UTF-8。

                  Messages标签:WARN_LOGFILE最好设置上,比如类似Error.log等,优秀的程序员调试程序的能力最强啦,这个WARN_LOGFILE恰恰类似于编程当中的Error,其包含了提示出错问题。

                   Input标签:如果源程序按功能进行了分类,放置于不同文件夹,则需要添加不同文件夹路径。不过这种方法容易出问题,也麻烦,建议把所有源文件放置于同一目录下。毕竟我们只要生成的技术文档,这里的INPUT源代码只是用一用,用完可以删除。DOXYFILE_ENCODING默认为UTF-8。

                   Source Browser标签:将SOURCE_BROWSER勾选上,其他默认。

                   Index标签:可选填,因为这个是为了生成ftf/word的目录用的,如果你没把握弄好,在word里改也可以,而且选项更丰富。

                    HTML+LaTex标签:两个标签都取消第一个框的勾选,因为我们是要生成rtf/word。

                   RTF标签:勾选上第一个框,RTF_OUTPUT选择你想输出到的目录。

                   Dot标签:将UML_LOOK勾选上,可以生成UML类关系图,其余勾选项选上最好。分别是模板(TEMPLATE)、调用(CALL)、被调用(CALLER)图,这样不是更方便吗,所以建议勾选。同时,在安装了graphviz前提下(务必先安装,用于生成UML图),在DOT_PATH中,添加graphviz的bin目录。

        第三步:保存一下吧,休息,休息一会.

                   点击Step2下的Save,保存一下,不然以后要是有啥事,你刚才的工作白做了可别怪我。

        第四步:快到了,看到终点线了(directory).       

                   设置Working directory(工作目标),选择源代码的根目录,主要是因为配置的一些选项中有的可以用相对路径,这个就可以作为相对路径的参照点。

        最终步:Start吧,新的开始.

                    终于结束了,我的程序较大,生成了10秒多呢,心情激动啊。这只能是告一段落,让我们歇口气,不然为啥最后一步的按钮叫“Start”呢,呵呵,准备新的任务,新的开始,出发吧!

 

 

你可能感兴趣的:(doxygen生成word文档)