Sandcastle Help File Builder 2014.2.15.0 安裝說明
Sandcastle Help File Builder 是一套可以讀取 XML 文件檔案,來產生說明文件的工具程式。底下先簡單的介紹一下 XML 的文件編寫規則,運用這些標籤再透過 Sandcastle Help File Builder (簡稱為 SHFB) 就可以產生一個漂漂亮亮同時又清楚明遼的說明文件。
XML 註解標籤的說明
標籤名稱 | 說明 |
<summary></summary> | 物件的摘要說明文字。 |
<param name="Name">Description</param> | Name 為方法參數的名稱,Description 為參數的說明文字。 |
<remarks></remarks> | 詳細的功能說明文字。 |
<returns></returns> | 使用於方法宣告的註解來描述傳回值。 |
<value></value> | 描述屬性代表的值。 |
<example></example> | 範例說明文字,可內含 <code></code>。 |
<code></code> | 程式碼片段文字。 |
<seealso cref="MemberName" /> | 附加參閱的連結文字。MemberName 需為程式的成員。 |
<exception cref="MemberName">Description</exception> | 產生例外狀況的說明文字。Name為例外狀況所參考的成員名稱,Description為例外條件的描述說明文字。 |
XML註解內容中,是可以支援 HTML 語法,因此如果有多行的時後,可以使用 <br /> 來產生換行的動作。
範例:
可以看的出來,撰寫XML文件時,value 與 returns 最好依照目前的內容還挑選要使用 value 還是 returns。不過 XML 的標籤還不只有這些,其他的請參考 XML 文件註解(C#程式設計手冊)。
安裝 Sandcastle Help File Builder
至官方網站 https://shfb.codeplex.com/ 點選 Download 下載最新的版本 v2014.2.15.0 Beta - SHFBGuidedInstaller_2014.2.15.0.zip。
解壓縮檔案後,點選 SandcastleInstaller 開始進行安裝。
檢測 .NET Framework,必需要安裝到 4.0 版本。請參閱 Microsoft .NET Framework 4 (獨立安裝程式)。
檢測 HELP 編譯器。HTML Help 1 為 CHM 格式,Microsoft Help 2 為 HxS 格式。
檢測到沒有 HTML Help 1 的編譯器
下載 HTML Help Workshop - http://www.microsoft.com/en-us/download/details.aspx?id=21138,安裝完成後再點選 Search Again 就會顯示已找到。
檢測到沒有 Microsoft Help 2 的編譯器
下載 Visual Studio 2008 SDK 1.0 - http://www.microsoft.com/en-us/download/details.aspx?id=508,安裝完成後再點選 Search Again 就會顯示已找到。
按下 Install SHFB 後,開始安裝 Sandcastle Help File Builder。
SHFB 安裝完成。
接下來就是安裝 Visual Studio 相關的部份。
首先是 Package for 2010 / 2012 / 2013,可以讓你建立相關 SHFB 的專案。
安裝 MAML 的 Intellisense 基碼。
勾選要安裝的目地 Visual Studio。
安裝 MAML 的片段程式碼
勾選要安裝的目地 Visual Studio。
確認是否要安裝拼字檢查,如果需要的話請自行到 Visual Studio Gallery 中下載安裝,不然就下一步完成 SHFB 的安裝。
安裝完成後,可以執行 Sandcastle Help File Builder Project Launcher 來設定自 SHFB 的 GUI 開啟專案檔還是使用 Visual Studio 的 IDE 介面來開啟專案檔。
安裝程式會自動新增 SHFBROOT 的環境變數,來記錄 SHFB 的安裝主路徑。如果重新開機之後在DOS視窗中找不到,那麼請自行到系統的環境變數設定去新增。
如此就安裝完成,接下來就可以開始使用了。
請參閱:Sandcastle Help File Builder 使用說明。
程式是運氣與直覺堆砌而成的奇蹟。
若不具備這兩者,不可能以這樣的工時實現這樣的規格。
修改規格是對奇蹟吐槽的褻瀆行為。
而追加修改則是相信奇蹟還會重現的魯莽行動。