關於sandcastle網上的參考資料相對較少，google出來很多資料都是全英文的，相對於我這種英語渣渣看起來還是很費勁的。
言簡意賅，sandcastle主要功能是能夠將c#類生成類似msdn風格幫助文件的工具，支援本地化，並提供乙個基本的命令列編譯器介面和乙個visual studio外掛程式。
優點：
1.生成簡單，工作量小，幾分鐘之內就能完成乙個專案的api文件製作。
2.自動生成索引項、內容專案表、主題塊和頁面布局，提高一致性和熟悉程度。
3.**高亮，易讀性強
4.生成api介面美觀。
缺點：
只支援visual studio,意思是只支援微軟旗下產品。
這個版本中備註描述的很清楚，這是最後乙個支援vs2013的版本。
主要配置詳解
3.1 首先開啟sandcastle，新建乙個檔案用來存放sandcastle新建的工程檔案，類似vs中新建專案後的解決方案。
3.2 在專案屬性中選擇需要生成的api型別，如果你想生成類似msdn幫助文件風格，就可以選擇website。
3.3 framework version 選擇生成解決方案的framework版本號，如果與之不一致，則生成api時會報錯
chm型別生成的文件（參考）
website型別
在vs中的引用類按f1可開啟該類的幫助文件。
3.4.點選project explorer，點選新建的api檔案，右擊documentation sources選擇add document source
3.5 選擇的類庫生成屬性中需在輸出中xml文件檔案核取方塊打鉤在生成，否則生成api無效。
3.6 選擇所需生成的類庫，也就是字尾名為.csproj的檔案即可
4.1 shfb: error be0043: unexpected error detected in last build step. see output above for details.錯誤資訊的意思是缺少程式集的引用，那我就需要把不用的程式集剔除掉，那麼如何剔除呢，請看一下操作
4.2 shfb: error be0064: build cancelled by user這個錯誤是由於框架版本不一致所引起的，也就是如果該專案生成時選擇的framework版本為4.5，而sandcastle配置的是4.0版本，那麼就會報錯。
4.3 sandcastle [丟失節點]的問題遇到這個問題，首先檢視**注釋是否有節點，是否規範。
然後有人會說我明明在**中已經定義了summary 節點，為什麼還會報這種錯呢？
這種我嘗試最暴力的方法就是讓它不提示這個錯誤，在sandcastle中設定missing tags，取消elments 的報錯資訊，點選取消核取方塊，哪個節點的報錯就不會報錯。
前面說了都是sandcastle軟體的獨立使用，還有一種方法是將其整合在vs中使用，使用方法與獨立使用相差不大。
如果是已經安裝了sandcastle，那麼請忽略以下安裝步驟。
5.1 在sandcastle目錄資料夾下找到字尾為vsix的外掛程式，雙擊執行，如果彈出此擴充套件已安裝，那麼表示安裝成功
5.2 在需生成api的專案下新增專案，如果已安裝成功，那麼在已安裝的擴充套件外掛程式中documentation就會出現sandcastle外掛程式，輸入名稱，存放位置，點選確定新增。
5.3.新增完成後，此時的操作和不是整合在vs中的無明顯差別，如需生成文件，右擊新建的檔案，點選生成即可。
上面所有步驟完成之後就可以執行sandcastle了，點選build the help file生成
生成成功之後在當前生成目錄下，檢視生成檔案是否齊全，如果檔案不全，那麼原因在於生成不成功或配置不正確
雙擊index.html檢視api中是否有報錯資訊，**是否高亮，鏈結是否可點。
apiDoc 生成api文件
安裝node.js 安裝apidoc npm install apidoc g在你的專案根目錄下新建apidoc.json檔案，該檔案描述了專案對外提供介面的概要資訊如名稱 版本 描述 文件開啟時瀏覽器顯示標題和介面預設訪問位址。apidoc.json apidefine rknotfoundexc...
API文件自動生成
1 安裝coreapi pip install coreapi 2 在路由配置文件鏈結 from rest framework.documentation import include docs urls urlpatterns path docs include docs urls title 站...
DocFX生成API文件
弄了個開源專案 unity shader graph中英文對照api 採用docfx對markdown文件進行生成 docfx 簡單使用方法 自動生成目錄的工具 使用docfx 建立屬於你的github 文件頁面 當然如果你希望本地看 windows使用者需要自行配置iss，然後新增 選擇 site...