當我們開發好一個通信庫的時候，我們希望給這個通信庫配備一個幫助文檔，最好的方式，就是有一個離線的chm版本的API文檔，這樣别人在使用的時候，就可以清楚看到命名空間、類的結構，同時也能看到每個方法和屬性的結構。
剛好最近在制作xktComm通信庫的API幫助文檔，借此機會，跟大家介紹一下如何制作API文檔。
1、首先要将制作的dll寫好注釋，在類庫項目屬性中，勾選XML文檔檔案，這樣就會生成該dll對應的說明文檔xml檔案。
2、然後需要下載下傳一個軟體SHFB，下載下傳位址在github上：https://github.com/EWSoftware/SHFB/releases
選擇最新版下載下傳即可。
如果github通路不了，可以通過公衆号【dotNet工控上位機】擷取，回複關鍵詞：API制作套裝
擷取到的SHFB軟體目錄如下所示：
3、打開InstallResources檔案夾，找到SandcastleHelpFileBuilder.msi，輕按兩下安裝，安裝過程很簡單，一路Next即可。
4、安裝完成後，在跳到InstallResources檔案夾同級目錄，找到SandcastleInstaller.exe，輕按兩下安裝。
5、安裝過程會彈出兩次下圖的提示框，點選是，繼續到下一步。
6、安裝完成後，在開始菜單中的最近添加中，找到Sandcastle Help File Builder GUI，點選打開。
7、打開之後，如果出現下面的錯誤提示，說明需要安裝一個插件——BuildTools，擷取方式，在前面擷取的API制作套裝中，有一個名稱為BuildTools_Full.exe的程式，輕按兩下安裝，如果沒有錯誤，這一步跳過即可。
8、成功打開後，建立一個項目，名稱自己定義，添加第一步中準備好的dll及其對應的xml文檔。
9、然後通過左側的向導進行一些相關的設定，首先是Build頁面，主要設定文檔生成類型、語言及架構版本。
10、切換到第二欄Help File，設定相關的Title、版本号及相關版權資訊。
11、點選Documentation下的Build Project按鈕，生成項目。
12、如果出現下圖錯誤，錯誤代碼BE0037，需要安裝一個插件——htmlhelp，對應的安裝包已經放到API制作套裝中，擷取方式，公衆号背景回複：API制作套裝。
13、安裝完成後，重新Build Project，如果仍然出現錯誤，錯誤代碼BE0065，需要再安裝一個插件——vs_buildtools，對應的安裝包已經放到API制作套裝中，擷取方式，公衆号背景回複：API制作套裝。
14、不出意外的話，應該可以生成，生成結果如下：
15、這樣我們就生成了一個API的幫助文檔，我們可以對照Log，看看有哪些警告，因為可能有一些地方我們的注釋并不完整。
16、有個地方值得注意，當我們将所有的方法和類都添加注釋後，我們生成的時候，可能還會有警告，大緻意思是命名空間并沒有注釋，命名空間的注釋在代碼裡是添加不了的，需要在Sandcastle Help File Builder GUI軟體中添加，點選左側導航欄的Summaries，點選Edit Namespace Summaries，進入界面後，通過點選選擇命名空間，右擊一下，就可以輸入所選命名空間的注釋說明，全部輸入完成後，點選Close即可。
16、下面是最終生成的chm幫助文檔。【圖檔有誤，背景回複API，檢視完整版】