[Sandcastle V2.6] 使用Sandcastle Help File Builder V1.9 製作Help Doc (VS.NET)

最近因為專案要用.Net solution，利用Sandcastle製作Help Doc，由於網路上能找得的說明文章都是舊版的，介面等等有點不一樣，所以Seven在研究之後乾脆自己寫一篇。Sandcastle是一個 Microsoft提出的套件，當初好像為了取代NDOC，這個套件可以用來產生.chm或者WebBase的說明文件，有點像是Javadoc，但是由 於Sandcastle只有命令提示模式，所以需要Sandcastle Help File Builder來提供GUI介面，讓使用者可以更方便操作

需要安裝的元件如下：


Sandcastle June 2010 Release (V2.6.1062.1)
http://sandcastle.codeplex.com/

Sandcastle Help File Builder Jul 7 2010 Release (SHFB V1.9.1.0)
http://shfb.codeplex.com/
這個版本會refer上面V2.6.1062.1，如果上面Sandcastle是舊版的話就會Build Project失敗


HTML Help Workshop(for Building .chm)
http://msdn.microsoft.com/en-us/library/ms669985.aspx

.NET Framework 3.5 SP1 如果有裝VS.net應該都會有這個，裝2010的話應該會是V4.0版

MS Help 2 compiler (for building MS Help 2 .HxS) VS2005 VS2008要下載安裝SDK，如果當初安裝VS的時候有裝就不用再下載
VS2005 SDK 或者
VS2008 SDK

VS2010則在安裝時候就會一並安裝了，所以不用

如果是VS2005或者VS2008，裡面會包含舊版的Sandcastle，請檢查環境變數
把DXROOT指到新安裝的目錄 ex C:\Program Files\Sandcastle
[更改環境變數需要重開機才會生效]

測試你安裝的SandCastle Help File Builder是否可正常使用

1.打開SandCastle

2.New一個Project

3.在Project Explorer中[Documentation Sources]滑鼠右鍵[Add Documentation Resource]
選取sample file中的檔案做測試，加入下面兩個檔案
C:\Program Files\Sandcastle\Examples\Sandcastle\test.dll
C:\Program Files\Sandcastle\Examples\Sandcastle\comments.xml (這個要加，不然會沒有說明)

4.按Save，接著Documentation中[Build Project]
如果順利build完沒有Error
最後要出現Build complete successfully at.....

5.[Documation]->[View Help File]應該就會看到Help File
跟C:\Program Files\Sandcastle\Examples\Sandcastle\test.cs對照一下

因為這個Increment有overloading，所以有兩個method以及註解

這樣就表示Sandcastle Help File Builder可正常使用

延伸閱讀：
[.Net] C#的註解方式以及XML的說明文件