作者: "zyl910" 一、緣由 “Sandcastle Help File Builder”(簡稱SHFB)是一個很好用.NET 幫助文檔生成工具。 但它的每個版本支持的VS版本範圍有限,且官網沒有明確說明它與VS版本的區別。導致經常出現“明明裝了SHFB,但VS打開不了它的項目”問題。 這時只 ...
作者: zyl910
一、緣由
“Sandcastle Help File Builder”(簡稱SHFB)是一個很好用.NET 幫助文檔生成工具。
但它的每個版本支持的VS版本範圍有限,且官網沒有明確說明它與VS版本的區別。導致經常出現“明明裝了SHFB,但VS打開不了它的項目”問題。
這時只有逐個版本安裝嘗試了。而GitHub下載速度慢,導致要花很久時間才能找到合適的版本。於是我做了一次完整的實驗,有了一些心得。
二、心得
2.1 嘗試安裝2個版本
最初曾經試過安裝2個版本的辦法——
- “先安裝舊版本SHFB,再安裝新版本SHFB”的辦法無效。系統中只能存在一個SHFB版本,安裝新版本後,舊版本會被覆蓋掉。導致還是僅支持新版本的VS範圍。
- “先安裝舊版本SHFB,再安裝新版本的vsix”的辦法無效。低版本VS編譯正常,高版本VS雖然能打開SHFB項目,但無法編譯,提示需要升級SHFB。
- “先安裝新版本SHFB,再安裝舊版本的vsix”的辦法無效。高版本VS編譯正常,低版本VS雖然能打開SHFB項目,但無法編譯,提示.NET版本問題等錯誤。
- “先安裝舊版本SHFB,先安裝新版本SHFB,再安裝舊版本的vsix”的辦法無效。高版本VS編譯正常,低版本VS雖然能打開SHFB項目,但無法編譯,提示.NET版本問題等錯誤。
該思路不行。看來只能挑一個版本了。
2.2 版本選擇
逐個安裝測試了SHFB對VS的支持範圍——
- SHFBGuidedInstaller_2015.01.12.0: 支持VS2010~VS2013 及 VS2015預覽版。shfb.codeplex.com的最後版本。
- SHFBInstaller_v2015.5.2.0: 支持VS2010~VS2015。【註意】該版本是支持VS2010的最後一個版本。
- SHFBInstaller_v2015.7.25.0: 支持VS2013~VS2015。【註意】該版本不再支持VS2010、VS2012。
- SHFBInstaller_v2016.4.9.0: 支持VS2013~VS2015。
- SHFBInstaller_v2016.5.28.0: 支持VS2013~VS2015 及 VS2017預覽版。
- SHFBInstaller_v2016.9.17.0: 支持VS2013~VS2015 及 VS2017預覽版。
- SHFBInstaller_v20171.28.0: 支持VS2015 及 VS2017預覽版。【註意】該版本是支持VS2013的最後一個版本。
- SHFBInstaller_v2017.5.15.0: 支持VS2015 及 VS2017(但實測發現其對VS2017支持還有很多問題)。【註意】該版本不再支持VS2013。
目前主要是 VS2010、VS2015這2個版本的使用率較高,故應選擇“SHFBInstaller_v2015.5.2.0”。
2.3 打開SHFB高版本項目文件問題
上一節說我們選定了“SHFBInstaller_v2015.5.2.0”這個版本。但當遇到高版本的SHFB項目文件時,該怎麼辦呢?
首先,嘗試安裝2個版本的辦法是行不通的,詳見“2.1 嘗試安裝2個版本”。
辦法是——
- 用文本編輯器打開shfbproj文件,將SHFBSchemaVersion的值改為“1.9.9.0”(例如將
<SHFBSchemaVersion>2015.6.5.0</SHFBSchemaVersion>
改為<SHFBSchemaVersion>1.9.9.0</SHFBSchemaVersion>
)。
修改了版本之後,一般就能用“SHFBInstaller_v2015.5.2.0”正常處理了。
參考文獻
- http://shfb.codeplex.com/
- https://github.com/EWSoftware/SHFB
- ASP.NET 魔法學院(jeff377)《使用 Sandcastle Help File Builder 製作 VS.NET 的 HELP 文件》. http://www.cnblogs.com/jeff377/archive/2008/11/15/1334233.html
SHFBInstaller_v2015.5.2.0.zip
http://pan.baidu.com/s/1sltz2PZ