當(dāng)我們開發(fā)好一個(gè)通信庫的時(shí)候，我們希望給這個(gè)通信庫配備一個(gè)幫助文檔，最好的方式，就是有一個(gè)chm版本的API文檔，這樣別人在使用的時(shí)候，就可以清楚看到命名空間、類的結(jié)構(gòu)，同時(shí)也能看到每個(gè)方法和屬性的函數(shù)。

剛好最近在制作xktComm通信庫的API幫助文檔，借此機(jī)會(huì)，跟大家介紹一下如何制作API文檔。

1. 首先要將制作的dll寫好注釋，在類庫項(xiàng)目屬性中，勾選XML文檔文件，這樣就會(huì)生成該dll對(duì)應(yīng)的說明文檔xml文件。

2、然后需要下載一個(gè)軟件SHFB，下載地址在github上：

https://github.com/EWSoftware/SHFB/releasesgithub.com

選擇最新版下載即可。

如果github訪問不了，可以通過公眾號(hào)【dotNet工控上位機(jī)】獲取，回復(fù)關(guān)鍵詞：API制作套裝

獲取到的SHFB軟件目錄如下所示：

3、打開InstallResources文件夾，找到SandcastleHelpFileBuilder.msi，雙擊安裝，安裝過程很簡(jiǎn)單，一路Next即可。

4、安裝完成后，在跳到InstallResources文件夾同級(jí)目錄，找到SandcastleInstaller.exe，雙擊安裝。

5、安裝過程會(huì)彈出兩次下圖的提示框，點(diǎn)擊是，繼續(xù)到下一步。

6、安裝完成后，在開始菜單中的最近添加中，找到Sandcastle Help File Builder GUI，點(diǎn)擊打開。

7、打開之后，如果出現(xiàn)下面的錯(cuò)誤提示，說明需要安裝一個(gè)插件——BuildTools，獲取方式，在前面獲取的API制作套裝中，有一個(gè)名稱為BuildTools_Full.exe的程序，雙擊安裝，如果沒有錯(cuò)誤，這一步跳過即可。

8、成功打開后，新建一個(gè)項(xiàng)目，名稱自己定義，添加第一步中準(zhǔn)備好的dll及其對(duì)應(yīng)的xml文檔。

9、然后通過左側(cè)的向?qū)нM(jìn)行一些相關(guān)的設(shè)置，首先是Build頁面，主要設(shè)置文檔生成類型、語言及框架版本。

10、切換到第二欄Help File，設(shè)置相關(guān)的Title、版本號(hào)及相關(guān)版權(quán)信息，

11、點(diǎn)擊Documentation下的Build Project按鈕，生成項(xiàng)目。

12、如果出現(xiàn)下圖錯(cuò)誤，錯(cuò)誤代碼BE0037，需要安裝一個(gè)插件——htmlhelp，對(duì)應(yīng)的安裝包已經(jīng)放到API制作套裝中，獲取方式，公眾號(hào)后臺(tái)回復(fù)：API制作套裝。

13、安裝完成后，重新Build Project，如果仍然出現(xiàn)錯(cuò)誤，錯(cuò)誤代碼BE0065，需要再安裝一個(gè)插件——vs_buildtools，對(duì)應(yīng)的安裝包已經(jīng)放到API制作套裝中，獲取方式，公眾號(hào)后臺(tái)回復(fù)：API制作套裝。

14、不出意外的話，應(yīng)該可以生成，生成結(jié)果如下：

15、這樣我們就生成了一個(gè)API的幫助文檔，我們可以對(duì)照Log，看看有哪些警告，因?yàn)榭赡苡幸恍┑胤轿覀兊淖⑨尣⒉煌暾?/p>

16、有個(gè)地方值得注意，當(dāng)我們將所有的方法和類都添加注釋后，我們生成的時(shí)候，可能還會(huì)有警告，意思是命名空間并沒有注釋，命名空間的注釋在代碼里是添加不了的，需要在

Sandcastle Help File Builder GUI軟件中添加，點(diǎn)擊導(dǎo)航欄的Summaries，點(diǎn)擊Edit Namespace Summaries，進(jìn)入界面后，通過點(diǎn)擊選擇命名空間，右擊輸入所選命名空間的注釋說明，輸入完成后，點(diǎn)擊Close即可。

16、下面是最終生成的chm幫助文檔。