程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> .NET實例教程 >> 用Sandcastle一鍵生成CHM幫助文檔

用Sandcastle一鍵生成CHM幫助文檔

編輯:.NET實例教程
NDoc是一個很好的工作,可以把.Net中的注釋導出,生成chm文檔一邊查閱和管理。可惜因為沒有得到開源社區的支持已經停止開發。

Sandcastle原本是微軟內部用於開發管理的一個工具,它的功能和NDoc基本一致。由於它能夠得到微軟的支持,所以更新和維護基本不用擔心。

但Sandcastle目前還不夠完善,至少有兩點不足:

1、目前只能通過doc命令執行,沒有GUI;

2、目前只支持單個工程,不能合並處理整個解決方案。

微軟承諾以後的版本會做功能升級和完善,但何時能夠完成並沒有時間表。

針對這兩點不足,已經有人做了很好的GUI軟件,以滿足人們需求。但仍然會有一些缺陷無法很好滿足。

實際上,最新的Sandcastle版本內部包含的一個bat文件,已經把十幾個步驟的doc命令進行了集成,使得用戶只要一個doc命令就可以完成整個doc命令集操作。

實現方法如下:

1、下載並默認安裝Html Help Workshop和Sandcastle;

2、新建一個空目錄(如:example),把需要處理的工程的dll文件和包含注釋信息的工程XML文件拷貝到這個目錄下(如:這個工程為test,則,這兩個文件分別是:test.dll和test.XML);

3、到“C:\Program Files\Sandcastle\Examples\sandcastle”目錄下拷貝“build_Sandcastle.bat”文件到example目錄下;

4、打開cmd窗口,轉到example目錄下,執行如下命令:build_Sandcastle vs2005 text;

5、幾分鐘之後,執行完畢你可以在cmd目錄下看到test.chm文檔。


  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved