方法一、Visual Studio新建documentation生成幫助文檔
前段時(shí)間在網(wǎng)上收集和自己平時(shí)工作總結(jié)整理了《干貨,比較全面的c#.net公共幫助類》，整理完成上傳github之后我又想，既然是幫助類，總得有個(gè)幫助文檔于是乎想到了Sandcastle，Sandcastle是微軟官方生成幫助文檔這發(fā)面的工具。
它可以配合Microsoft Visual Studio生成的dll和xml注釋文件生成完整的幫助文檔。
結(jié)合可視化工具Sandcastle Help File Builder，簡(jiǎn)單直接，還能生成各種屬性的說明。
支持Helpe1x:chm, Helper2x:Hxs, Website,HelperView等多種格式而且擴(kuò)展靈活功能強(qiáng)大，下面我們就看一下怎樣用Sandcastle生成chm文檔。
一、下載
首先我們前往CodePlex下載Sandcastle，地址:http://sandcastle.codeplex.com/
然后下載Sandcastle Help File Builder，地址：http://shfb.codeplex.com/，點(diǎn)擊右邊download下載即可。
二、安裝
Sandcastle，直接Next就可以了，Sandcastle Help File Builder要說一下的是，在MAML Schema IntelliSense for Visual Studio為vs安裝插件的時(shí)候一定要勾選上，不然新建項(xiàng)目的時(shí)候會(huì)沒有這個(gè)選項(xiàng)。
三、設(shè)置
在生成這里設(shè)置xml文檔文件，保存，編譯之后在你項(xiàng)目目錄的bin\Debug就會(huì)看到生成的xml文件了。
四、新建項(xiàng)目documentation
首先 新建documentation項(xiàng)目，這里就是安裝Sandcastle Help File Builder的時(shí)候勾選上vs的原因。如果沒有勾選上，這里新建的時(shí)候沒有這個(gè)選項(xiàng)的。
然后勾選上你剛才已經(jīng)生成的dll和xml文件，右鍵屬性如上圖寫上標(biāo)題。編譯生成即可。這里有一點(diǎn)要注意，可能會(huì)報(bào)錯(cuò)（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，當(dāng)然你安裝了之后可以跳過此步驟。
如果沒有安裝Microsoft HTML Help，我們到https://www.microsoft.com/en-us/download/details.aspx?id=21138去下載Microsoft HTML Help然后安裝。
五、生成
如果沒有報(bào)錯(cuò)，直接生成，然后我們項(xiàng)目目錄的Help就可以看到生成的幫助文檔了
是不是很簡(jiǎn)單。這樣我們就生成了之前幫助類的幫助文檔了。另外我再介紹幾種生成幫助文檔的方式。
方法二、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 回車，然后進(jìn)行批處理。
我們會(huì)看到這目錄下生成很多文件夾，如果過程沒有報(bào)錯(cuò)，我們?cè)赾hm 文件夾就會(huì)看到我們生成的幫助文檔了。
方法三、SandcastleBuilderGUI
我們根據(jù)上面的設(shè)置，然后引入Common.Utility.dll 和Common.Utility.xml，生成即可。相關(guān)設(shè)置參考：http://www.cnblogs.com/lonely7345/archive/2010/01/13/1647245.html
方法四、Sandcastle Help File Builder可視化工具
通過Sandcastle的圖形操作界面。在C:\Program Files (x86)\Sandcastle\Examples\Generic\SandcastleGui.exe下打開如下界面。
根據(jù)圖上相關(guān)設(shè)置然后點(diǎn)擊Build按鈕。即可生成幫助文檔，是不是更方便簡(jiǎn)潔。
當(dāng)然前提是也是生成Common.Utility.dll 和Common.Utility.xml的情況下面。
如上四種方法生成幫助文檔。至此c#.net幫助類告一段落。
github地址：https://github.com/Jimmey-Jiang/Common.Utility喜歡點(diǎn)下star
