【趙劼】Sandcastle：生成.NET API文件的工具

Sandcastle是一個微軟釋出的工具，它通過反射程式集中的原始碼以及新增程式碼中的XML註釋來建立MSDN形式的API文件。在CodePlex中剛釋出了Sandcastle的一個新版本。 這個工具的原始碼可以在CodePlex中以微軟公開許可協議（Microsoft Public License）下獲得。即使某些API不會公開，為其建立文件也是個非常值得推薦的做法，因為這些文件在總會被其他一些內部開發人員使用。而對於公開的API來說，這樣的文件則更是必不可少的東西了。

Sandcastle的首次公開露面是在2006年，它的開發週期已經超過了2年。目前釋出的為CTP版本，但是“1.0版”應該會在不久的將來發布。NDoc則是另一個生成API文件的開源工具，在數年前微軟宣佈要建立Sandcastle專案後，其開發就停止了。其他還有一些在NDoc的基礎上開發的專案，比如NDoc 2005和NDoc3等，但是它們仍處於alpha開發階段。

Sandcastle能夠生成類似MSDN一樣的文件，就像這個示例中的結果一樣。Sandcastle的主要功能有：

• 相容署名或未署名的註釋
• 支援範型以及.NET 2.0框架
• 微軟內部用它來生成.NET框架的文件
• 能夠聲稱Visual Studio 2005、hana或prototype （CHM，HxS）型別的文件

Sandcastle能夠在命令列或GUI工具裡生成文件，這裡可以查閱它的使用指南。Sandcastle是一個獨立的工具，因此它能夠與任意Visual Studio專案一起工作。目前有一些將其與Visual Studio整合的計劃，但是還沒有得出最終決定。目前的版本能夠同時在32位和64位的機器上使用。

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/12639172/viewspace-364709/，如需轉載，請註明出處，否則將追究法律責任。