karatejb: 使用Sandcastle工具在Visual Studio環境產生Help文件(2014)

2014年10月29日星期三

因專案需要產出API文件，所以又想到很久沒用的Sandcastle~

結果發現原本的Sandcastle Codeplex網站已經換地方 (如下)，

The Sandcastle CodePlex project is no longer under active development by Microsoft and as such, there will be no future releases to this site.

真是物換星移，想當初第一次使用我還是個漂泊男子漢，轉眼間已經是個小孩子的爸爸了。 (扯遠了…)

1. 這次下載回來的版本是2014.5.31.0，解開後的檔案如下，直接安裝它。

安裝過程中會有一些extra package可以整合到Visual Studio的IDE環境使用，如果不想直接使用Sandcastle的GUI可考慮安裝。個人是建議安裝。

安裝程式會自動detect你有幾個VS的版本；在2013未release前，小弟開發機上有2008/2010/2012三種版本，後來新版本在轉換舊有專案上都很穩定和方便，所以陸續就移除了~

2. Sandcastle GUI

安裝完成後可直接使用GUI新增一個Project，只要在Project Explorer去選取我們的開發專案就可以了，其他設定都很直覺。

PS. 如果選擇產出的類型為 Open XML，請務必到”Help File”的Presentation style屬性改為： Open XML Document!

3. Visual Studio Sandcastle Help File Builder Project

如果將Sandcastle整合到VS，可直接在方案中新增一個Help File Builder Project。

Import類別庫專案，一樣是在【Documentation Sources】加入。

在此專案屬性可做設定~ 建置此專案後就會在專案資料夾「Help」下產出文件。

PS. 如果電腦比較慢且習慣Build整個方案的朋友，請設定不要建置 Help File Builder Project，否則又會拖慢建置時間，有需要再手動建置吧。

4. Output

For example, a word(Open XML) file.

karatejb