Sandcastle是一個管理類庫的文檔編譯器，是用于編譯發(fā)布組件（Assembly）信息的一個工具，這個工具通過反射和Xslt技術(shù)，可以從dll文件及其xml注釋（命令行編譯時加/doc參數(shù)或vs2005設(shè)置項目屬性得到）得到一個完整的幫助文檔，格式可以是Html或CHM甚至是任何自定義的格式。

Sandcastle中組件：

MrefBuilder、Build Assembler和XslTransform。這些工具使用編譯匯編代碼時生成的輸出結(jié)果，包括DLL文件以及XML注釋文件。

MrefBuilder反射一個項目的匯編代碼并生成一個輸出文件。MrefBuilder是一個隨Sandcastle安裝的命令行工具。它生成的輸出文件通過XslTransform命令行工具轉(zhuǎn)換成一個叫做reflection.xml的文件。reflection.xml文件包含所有文檔數(shù)據(jù)，但不提供顯示細節(jié)。

MrefBuilder完成工作后，立即由Build Assembler接手處理。Build Assembler可由命令行工具BuildAssembler啟動。它利用由MrefBuilder生成的數(shù)據(jù)(reflection.xml)和任何代碼注釋（保存在獨立的XML文件中），生成按邏輯分組的HTML文件。HTML Help Compiler再利用這些HTML文件生成最終結(jié)果。

該工具并未限制你一次處理一個匯編。如果你需要處理幾個匯編代碼，你必須深入了解Sandcastle配置文件。它是一個包含建立幫助文件主題所需步驟的XML文件。

andcastle生成的輸出結(jié)果特點：

1、類似于MSDN布局的界面。

2、自動生成索引項、內(nèi)容項目表、主題塊和頁面布局，提高一致性和熟悉程度。

3、自動生成語法宣稱部分。

4、自動生成繼承表。

5、代碼彩色化。

6、提供多種風(fēng)格和語言選擇，終端用戶可從中選擇自己最喜歡的形式。

7、輸出結(jié)果以HTML和CSS形式顯示，微軟承諾將來提供更多選擇。

Sandcastle示例：

Sandcastle是微軟提供的一個根據(jù)XML注釋和DLL文件生成幫助文件的工具，目前是在CodePlex上的一個開源項目。

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

我們創(chuàng)建一個簡單的ClassLibrary1項目最為示范：

using System;
using System.Collections.Generic;
using System.Text;
namespace ClassLibrary1
{
   /// <summary>
   /// A sample class to show something using Sandcastle
   /// </summary>
   public class SampleClass
   {
       private string _propertyValue;
       /// <summary>
       /// Gets or sets the property value.
       /// </summary>
       /// <value>The property value.</value>
       public string Property
       {
           get
           {
               return _propertyValue;
           }
           set
           {
               _propertyValue = value;
           }
       }
       /// <summary>
       /// Determines whether the property is null.
       /// </summary>
       /// <returns>
       ///     <c>true</c> if property is null; otherwise, <c>false</c>.
       /// </returns>
       public bool IsPropertyNull()
       {
           bool result = false;
           if (this.Property == null)
           {
               result = true;
           }
           return result;
       }
       /// <summary>
       /// Determines whether the property is null.
       /// </summary>
       /// <returns>
       ///     <c>true</c> if property is empty; otherwise, <c>false</c>.
       /// </returns>
       /// <example>
       /// This example shows how you might use this method:
       ///
       /// <code>
       /// SampleClass sample = new SampleClass();
       ///
       /// if (sample.IsPropertyEmpty())
       /// {
       ///        Console.WriteLine("The property is empty");
       /// }
       /// else
       /// {
       ///        Console.WriteLine("The property contains value " + sample.Property);
       /// }
       /// </code>
       /// </example>
       public bool IsPropertyEmpty()
       {
           bool result = this.IsPropertyNull();
           if (!result)
           {
               result = (Property.Trim().Length == 0);
           }
           return result;
       }
   }
}

代碼很簡單，注意其中的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文件。

第四步，修改設(shè)置

在項目的屬性窗口，你可以根據(jù)需要修改一些設(shè)置。

第五步，生成文檔

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

這是最終生成的文檔：