ahjesus 創建msdn一樣的幫助文檔

轉載自http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html

使用SandCastle創建.Net幫助文檔

Sandcastle是微軟提供的一個根據XML注釋和DLL文件生成幫助文件的工具，目前是在CodePlex上的一個開源項目，可以去這裡下載：Sandcatle 項目
Sandcastle 本身是一個console的程序，為了方便使用，我們可以使用他的GUI版本：Sandcastle Help File Builder

第一步，為你寫的代碼添加XML注釋

我們創建一個簡單的ClassLibrary1項目最為示范：

 
     
       
         
         
         = 
         
         
              
          result =  (.Property == =  
         
         
              
         
         
         
         
         
         
          result =  (!= (Property.Trim().Length == 

代碼很簡單，注意其中的XML注釋。

打開項目的屬性，在“Build”選項中，確保“XML documentation file:”被選中了。

第二步，編譯這個項目，你會看到生成的DLL文件和XMl文件：

第三步，打開 Sandcastle Help File Builder

打開Sandcastle Help File Builder並新建一個項目：

為Sandcastle Help File Builder項目添加編譯生成的DLL文件，右鍵點擊項目右邊的“Documentation Sources",選擇“Add Documentation Source...”

選擇剛剛生成的DLL文件。

第四步，修改設置

在項目的屬性窗口，你可以根據需要修改一些設置。

第五步，生成文檔

點擊Build the help file來生成文檔。

這是最終生成的文檔：