四種Sandcastle方法生成c#.net幫助類幫助文檔
方法一、Visual Studio新建documentation生成幫助文檔
前段時間在網上收集和自己平時工作總結整理了《幹貨,比較全面的c#.net公共幫助類》，整理完成上傳github之後我又想，既然是幫助類，總得有個幫助文檔於是乎想到了Sandcastle，Sandcastle是微軟官方生成幫助文檔這發面的工具。
它可以配合Microsoft Visual Studio生成的dll和xml註釋文件生成完整的幫助文檔。
結合可視化工具Sandcastle Help File Builder，簡單直接，還能生成各種屬性的說明。
支持Helpe1x:chm, Helper2x:Hxs, Website,HelperView等多種格式而且擴展靈活功能強大，下面我們就看一下怎樣用Sandcastle生成chm文檔。
一、下載
首先我們前往CodePlex下載Sandcastle，地址:http://sandcastle.codeplex.com/
然後下載Sandcastle Help File Builder，地址：http://shfb.codeplex.com/，點擊右邊download下載即可。
二、安裝
Sandcastle，直接Next就可以了，Sandcastle Help File Builder要說一下的是，在MAML Schema IntelliSense for Visual Studio為vs安裝插件的時候一定要勾選上，不然新建項目的時候會沒有這個選項。
三、設置
在生成這裏設置xml文檔文件，保存，編譯之後在你項目目錄的bin\Debug就會看到生成的xml文件了。
四、新建項目documentation
首先 新建documentation項目，這裏就是安裝Sandcastle Help File Builder的時候勾選上vs的原因。如果沒有勾選上，這裏新建的時候沒有這個選項的。
然後勾選上你剛才已經生成的dll和xml文件，右鍵屬性如上圖寫上標題。編譯生成即可。這裏有一點要註意，可能會報錯（SHFB: Error BE0037: Could not find the path the the HTML Help 1 compiler. See the error number topic in the help file for details.），是沒有安裝Microsoft HTML Help，當然你安裝了之後可以跳過此步驟。
如果沒有安裝Microsoft HTML Help，我們到https://www.microsoft.com/en-us/download/details.aspx?id=21138去下載Microsoft HTML Help然後安裝。
五、生成
如果沒有報錯，直接生成，然後我們項目目錄的Help就可以看到生成的幫助文檔了
是不是很簡單。這樣我們就生成了之前幫助類的幫助文檔了。另外我再介紹幾種生成幫助文檔的方式。
回到頂部(go to top)方法二、cmd生成幫助文檔
在Sandcastle和Sandcastle Help File Builder都安裝好的前提下，
在我們將步驟三生成的Common.Utility.dll 和Common.Utility.xml 拷貝至C:\Program Files (x86)\Sandcastle\Examples\Sandcastle（Sandcastle安裝路徑）下面。
這種方法是一種批處理的方法,然後我們打開cmd,輸入build_sandcastle.bat vs2005 Common.Utility 回車，然後進行批處理。
我們會看到這目錄下生成很多文件夾，如果過程沒有報錯，我們在chm 文件夾就會看到我們生成的幫助文檔了。
回到頂部(go to top)方法三、SandcastleBuilderGUI
我們根據上面的設置，然後引入Common.Utility.dll 和Common.Utility.xml，生成即可。相關設置參考：http://www.cnblogs.com/lonely7345/archive/2010/01/13/1647245.html
回到頂部(go to top)方法四、Sandcastle Help File Builder可視化工具
通過Sandcastle的圖形操作界面。在C:\Program Files (x86)\Sandcastle\Examples\Generic\SandcastleGui.exe下打開如下界面。
根據圖上相關設置然後點擊Build按鈕。即可生成幫助文檔，是不是更方便簡潔。
當然前提是也是生成Common.Utility.dll 和Common.Utility.xml的情況下面。
如上四種方法生成幫助文檔。至此c#.net幫助類告一段落。
本文來自：http://www.cnblogs.com/anyushengcms/p/7682501.html
四種Sandcastle方法生成c#.net幫助類幫助文檔