随笔-341  评论-2670  文章-0  trackbacks-0

    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)上面。目前的话,只需要打开<root>\Libraries\GacUI\GacUISrc\GacUISrc.sln,使用debug编译之后,运行<root>\Libraries\GacUI\Public\Release.bat,就会在Temp\StaticHtmpDoc\目录下面产生一系列的html文件。目前这个文档的根节点是reference_gacui.html文件。

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

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

评论:
# re: 成功从VC++的XML注释生成静态html文档 2012-04-01 01:31 | 空明流转
师祖威武牛逼强大到爆!  回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档 2012-04-01 03:41 | ArthasLee
膜拜GaCUI之主&&宇宙无敌萌兔教主vczh君  回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档 2012-04-01 05:44 | 空明流转
这个其实是楼主的愚人节玩笑。  回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档 2012-04-01 05:50 | 陈梓瀚(vczh)
@空明流转
才不是呢,哼!  回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档 2012-04-01 20:55 | Zblc(邱震钰)
必定抽一两天仔细拜读下   回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档 2012-04-02 03:42 | bennycen
Orz  回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档 2012-04-05 18:07 | phoenixbing
无敌兔啊  回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档 2012-04-09 21:57 | Scan
终于理解到,老大的id是vczh=V + ChenZiHan  回复  更多评论
  
# re: 成功从VC++的XML注释生成静态html文档[未登录] 2012-04-11 17:47 | me
@Scan
V=Victor  回复  更多评论
  

只有注册用户登录后才能发表评论。
【推荐】超50万行VC++源码: 大型组态工控、电力仿真CAD与GIS源码库
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理