利用Sandcastle快速生成一個源代碼的幫助文檔

1.安裝Sandcastle(Version 2.6.1062.1)和SandcastleBuilder(SHFB v1.9.1.0 Release )

2.將源代碼的項目，進行設置，"生成"—"XML文檔文件"打鉤
3.運行SandcastleBuilder安裝出來的"Sandcastle Help File Builder GUI"。"Documentation Sources"右鍵點擊"Add Documentation Source..."添加目標解決方案的sln
4."Sandcastle Help File Builder GUI"的"Project Properties"中"Paths"中"OutputPath"設置輸出幫助文檔的文件目錄
5.點擊"Documentation"菜單中的"Build Project"，SandcastleBuilder會自動生成出一個CHM文檔，耗時較長。
注意：
1.註釋的編寫，參照：建議的文檔註釋標記（C# 編程指南）

2.項目一定要生成xml文檔文件，雖然編譯過程中會有未做註釋的警告。

SandcastleBuilder常用設置：

Build

FrameworkVersion：設置sln的.net版本

Help File

HelpTitle:CHM文件的標題名

HtmlHelpName:CHM文件的文件名

Paths

OutputPath:CHM文件輸出的目錄