每次要寫類別的描述都是一件苦差事
工程師表示,最討厭寫文件,最討厭別人不寫文件。
安裝 :
從 GitHub 上下載 : https://github.com/EWSoftware/SHFB
有幾個步驟有 install ,根據步驟往下安即可。安裝完畢後,即可以使用。
如果沒有 Html Helper 會引導到 MS 網站 下載
建立一個測試專案 Givemin5.Common
新增一個 Class1 :
對專案按右鍵,選擇屬性,在 Build 的最下面 XML Documentation file 打勾
建置的檔案裡面會多一個 xml 檔案
右鍵方案,新增新專案 選擇 Sandcastle Help File Builder Project
Documentation Sources 右鍵 選擇 Add Documentation Source
直接找到專案檔 (csproj)
加入後執行建置,建置完後,可以在專案資料夾裡面的 Help 看到 chm 檔案
打開後可以看到該專案的類別庫文件
(OS : 印出來就可以交差了)