Sandcastle是微軟推出的幫助文件製作工具也就是我們常說的API文件了
我們平常見到的.chm的就是幫助(API)文件了
這是一款開源免費的工具
使用這款工具可以幫我們製作常用的幫助(API)文件
配合visula studio開發工具就更加快捷好用了
前面說明過如何安裝和配置軟體
接下來就開始正式的製作我們的幫助(API)文件了
先從最簡單的開始,讓大家瞭解一下過程
工具/原料
Sandcastle
方法/步驟
開啟的軟體
在開啟的軟體主窗體中找到files-new project
選擇一個路徑
輸入使用者名稱然後選擇儲存
接下來我們就要使用vs2015來配合快速的生成幫助(API)文件了
首先使用vs2015新建一個mvc的簡單工程
新建mvc工程可以參考下面的連結
不想建立一個大工程我們可以簡單建一個類庫出來也是可以的
右鍵新增一個類庫出來
34 vs2015 新建MVC工程 visual studio 2015
有了類庫之後就要開始寫幫助(API)文件了
隨便找一個cs檔案並開啟
隨便寫一些註釋就好了
註釋如下圖
其實註釋就是我們幫助(API)文件的內容了
寫好後別忘了儲存
因為是要製作幫助(API)文件
我們還需要對我們的類庫做一下簡單的調整
找到解決方案管理器
右鍵選擇我們的工程
在彈出的選單中找到屬性
在開啟的屬性頁面中
左側找到生成
然後在右側找到輸出-XML文件路徑
勾選XML文件路徑
這裡會給出一個預設的路徑來,這個路徑是相對路徑
這個預設的路徑可根據自己的喜好來修改
之後儲存更改
然後編譯工程這一步一定不要忘了,不編譯工程這個XML檔案是出不來的
回到sandcastle中
在sandcastle中找到project explorer
在document and source中單擊右鍵
然後選擇add document source
然後找到我們剛剛建立的類庫檔案
選擇這個檔案選擇開啟
開啟後就可以看到這個工程已經新增到document and source中了
直接在右上角的選單欄中找到建制按鈕
執行就好了
執行過程會有進度條在右下角給與提示
執行完成後看到
Build completed successfully 後就說明建制成功了
找到選單欄中的放大鏡圖示就可以直接預覽幫助(API)文件了
這就是我們製作的幫助(API)文件了
我們之前加的註釋也就變成了說明了
這是一個最簡單的幫助(API)文件
通過Sandcastle還可以實現更多更詳細的功能
更進階的功能我們以後再講
注意事項
通過Sandcastle還可以實現更多更詳細的功能 更進階的功能我們以後再講
如果您覺得該經驗對您有用,請點選頁面左下角上的【大拇指】給本人一個支援。如果覺得對您有用請點選右下角處的分享按鈕,把該經驗分享給你的朋友們