vc 生成html,成功从VC++的XML注释生成静态html文档

GacUI的类库说明文档已经可以生成了！利用了之前的这篇博客描述的pdb信息抽取并和XML注释合并的技术，成功写了一系列工具来从这些信息里面生成静态html文档。现在的XML注释只写了1/3，所以生成的文档还不全。

之所以做这个工具，而不用Doxygen，是因为Visual C++对XML注释有着良好的支持。如果你为你的代码写了XML注释，那么在智能提示里面还可以看到成员的文档。但是这个形式的注释并不是Doxygen所接受的，而微软或其它开源工具对XML注释生成文档的工具仅限于.net程序(包括C++/CLI)。本来GacUI的release所提供的代码是几个压缩过的cpp和h文件，所以可以用一个C++/CLI工程去编译这个代码从而使用那些软件来产生文档的。不过本着造福大众兼磨练自己的精神，就写了一个专门针对VC++的Native C++工程编译产生的xml注释文件和pdb文件抽取数据合成文档的工具。

下面是文档的截图：

文档生成工具的代码已经提交到了Gac Library(http://gac.codeplex.com)上面。目前的话，只需要打开\Libraries\GacUI\GacUISrc\GacUISrc.sln，使用debug编译之后，运行\Libraries\GacUI\Public\Release.bat，就会在Temp\StaticHtmpDoc\目录下面产生一系列的html文件。目前这个文档的根节点是reference_gacui.html文件。

在Release.bat里面可以看出，我使用了\Common\Tools\下面的几个exe程序来读pdb、读xml注释并生成静态html文档。在与exe同名的目录下面，有这些工具的源代码。目前这个工具还不能处理模板类的xml注释，这个功能不久之后就会加上去。

posted on 2012-04-01 00:43 陈梓瀚(vczh) 阅读(3378) 评论(9)  编辑 收藏 引用 所属分类: GacUI