程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> 關於.NET >> Sandcastle介紹:生成.NET API文檔的工具

Sandcastle介紹:生成.NET API文檔的工具

編輯:關於.NET

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位的機器上使用。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved