GacUI的類庫(kù)說明文檔已經(jīng)可以生成了!利用了之前的這篇博客描述的pdb信息抽取并和XML注釋合并的技術(shù),成功寫了一系列工具來從這些信息里面生成靜態(tài)html文檔。現(xiàn)在的XML注釋只寫了1/3,所以生成的文檔還不全。
之所以做這個(gè)工具,而不用Doxygen,是因?yàn)閂isual C++對(duì)XML注釋有著良好的支持。如果你為你的代碼寫了XML注釋,那么在智能提示里面還可以看到成員的文檔。但是這個(gè)形式的注釋并不是Doxygen所接受的,而微軟或其它開源工具對(duì)XML注釋生成文檔的工具僅限于.net程序(包括C++/CLI)。本來GacUI的release所提供的代碼是幾個(gè)壓縮過的cpp和h文件,所以可以用一個(gè)C++/CLI工程去編譯這個(gè)代碼從而使用那些軟件來產(chǎn)生文檔的。不過本著造福大眾兼磨練自己的精神,就寫了一個(gè)專門針對(duì)VC++的Native C++工程編譯產(chǎn)生的xml注釋文件和pdb文件抽取數(shù)據(jù)合成文檔的工具。
下面是文檔的截圖:


文檔生成工具的代碼已經(jīng)提交到了Gac Library(http://gac.codeplex.com)上面。目前的話,只需要打開<root>\Libraries\GacUI\GacUISrc\GacUISrc.sln,使用debug編譯之后,運(yùn)行<root>\Libraries\GacUI\Public\Release.bat,就會(huì)在Temp\StaticHtmpDoc\目錄下面產(chǎn)生一系列的html文件。目前這個(gè)文檔的根節(jié)點(diǎn)是reference_gacui.html文件。
在Release.bat里面可以看出,我使用了<root>\Common\Tools\下面的幾個(gè)exe程序來讀pdb、讀xml注釋并生成靜態(tài)html文檔。在與exe同名的目錄下面,有這些工具的源代碼。目前這個(gè)工具還不能處理模板類的xml注釋,這個(gè)功能不久之后就會(huì)加上去。
posted on 2012-04-01 00:43
陳梓瀚(vczh) 閱讀(3586)
評(píng)論(9) 編輯 收藏 引用 所屬分類:
GacUI