? ? 當我們開發(fā)好一個通信庫的時候，我們希望給這個通信庫配備一個幫助文檔，最好的方式，就是有一個離線的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、安裝過程會彈出兩次下圖的提示框，點擊是，繼續(xù)到下一步。

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，查看完整版】

想學習上位機開發(fā)，可以加微信：thingerzj