Doxgen就是从你的代码中提取注释来生成供用户使用的说明文档,文档可以是各种格式,如html、rtf、xml等,不过我刚刚只是试验了html,感觉很不错。
Doxgen很容易上手,不到两个小时的时间已经算初步掌握。利用Doxwizard GUI可以很方便的设置自己所需要的文档效果,设置完后保存为一个配置文件就OK了,这样还有一个好处就是一个项目组的人按照自己的规范设置好后,其他人只需要拷贝这个配置文件,在开发过程中若要生成文档看一下,那么在运行Doxywizard的时候加载它就可以统一了。
设置很简单:
1. 在Output中设置输出为html并选中复选框with frames and a navigation tree,这样生成的html文档就可以看到一个浏览树在左侧;
2. 将OUTPUT_LAGUAGE一项选为chinese,这样生成的文档就可以显示在代码注释中写的中文了。
3. 为了在生成的文档中Brief Description中方便的生成说明,我在配置文件中手动更改了JAVADOC_AUTOBRIEF一项,将其设为YES,我在DoxyWizard GUI中没有找到设置这项的界面,所以手动改了。更改这项的好处是从Ogre的代码和文档中发现的。
4. 最后只要设置好目录就OK了。
写代码的注释方面:
1. 通常生成的文档是供用户看的,所以不需要用户看到的注释用“//”或“/* */”来做,而需要用户看到的就用“///”或“/** */”。而且一般需要用户看到的注释都是写在*.h文件中。
2. 注释写在对应的函数或变量前面。
3. 常用的注释方法:@remark 做评论,@par 用来对分段,@param 用来说明对函数参数做解释,@return 用来说明对函数返回值做解释。“///”用来做Brief description,而“/** */”用来做Detailed description,在将上面提到的JAVADOC_AUTOBRIEF设为YES后,则“/** */”内第一个句号前的部分自动作为Brief description。
以后就可以用这个工具了,不过记得一年前看的时候感觉这个东西没有Linux下那个texi2html生成的文档好看,不管怎样这个很方便,以后先用着。还有很多功能或许自己以后用得着。
贴着刚刚生成的文档的图片上来,呵呵,成就感……
相关推荐
doxygen代码文档生成工具
https://blog.csdn.net/qq21497936 doxygen和graphviz文档生成工具 osg帮助文档生成依赖工具
doxygen代码自动生成工具的使用说明。doxygen套件程序。还有一个例子项目。
doxygen文档生成工具
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML...
VC 6 文档生成工具:doxgen 能生成漂亮的技术文档的工具,以后再也不用为写技术文档发愁了。
doxygen根据代码注释生成文档,生成API,包含doxygen使用安装等说明文档。包含使用doxygen生成注释文档或API的全套工具
Doxygen, 大名鼎鼎的文档生成工具,被Boost、OpenCasCade等诸多项目作为文档生成的不二人选。
doxygen1.5.5 c++ 文档生成器 可以从c++源文件中生成chm帮助文件,支持接口帮助及UML类关系图
doxygen帮助文档生成工具,c++、java可以使用相同注释规范,然后生成帮助文档
Doxygen 文档生成 跨语言 按照良好的代码注释规则 文档轻松可见。
Doxygen的C++文档生成工具,里面包含涉及的安装及配置使用程序及文档。
doxygen代码文档生成工具包,包含软件:doxygen1.8.17,、graphviz2.38,htmlhelp三个软件,满足正常使用。
doxygen 1.61 十分好用的文档自动生成工具,尤其适合生成api手册。 示例、chm自动编译插件打包。关系图生成插件graphviz放在另外的链接提供下载,链接为http://download.csdn.net/source/2143324
用doxygen+graphviz自动化生成代码文档,相关博文:http://www.cnblogs.com/tianzhijiexian/p/4392924.html
google 上搜了很久的关于 Doxygen 使用方法的咚咚,只不过都是英文,而且都很多的规则。实际上大家只需要告诉基本的规则就可以。下面是我对 Doxygen 的摸索 首先熟知 Doxygen 产生的文件的基本结构
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。...首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文档。