使用Sandcastle 基於代碼註釋生成接口文檔

一. 工具下載：

1. Sandcastle：Sandcastle是微軟官方的文檔生成工具，下載地址：http://www.codeplex.com/Sandcastle  

2. SHFBGuidedInstaller：Sandcastle結合新發布的Sandcastle Help File Builder可視化工具，整個生成過程十分簡單。下載地址：http://shfb.codeplex.com/

分別安裝以上兩個工具後，打開 Sandcastle Help File Builder  GUI

選擇File->New Project

找一個位置保存咱們的配置文件，一般放在咱們的項目的根目錄下，保存成功後，如圖：

接下來，咱們就添加咱們的DLL文件了，添加以前，咱們要在咱們的代碼中添加註釋，及配置生成XML文檔

在Documentation Sources上右鍵，Add Documentation Source,找到咱們剛生成的XML文件（DLL文件也行 它會自動把兩個文件同時加入進來）

添加 成功後，咱們就開始配置中間的部分：

首先看Build，它讓咱們選擇生成什麼樣的文檔，默認勾選第一個，可是CHM文檔須要單獨安裝一個東檔，先無論它，咱們先生成website的就能夠了。

在Help File中，咱們要注意如下幾項： 語言選中文，Presentation style這個沒用，個人vs是2017，它連個選項都沒有，應該還支持2017， 

include root namespace container要勾選，不然只生成一個命名空間的文檔。

其它的配置，根據須要寫。

 

 在Summaries,裏配置要生成文檔的命名空間：

 

 其它的配置 省略。。。

最後點擊build 

 

註釋文檔就生成了。