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) 閱讀(3630)
評論(9) 編輯 收藏 引用 所屬分類:
GacUI