当前位置: 首页 > 图文教程 > 网络编程 > ASP.NET > Sandcastle介绍:生成.NET API文档的工具

ASP.NET
.NET中如何生成静态页
ASP.NET定制简单的错误处理页面
在客户端验证密码强度[2],兼容FireFox和IE
如何以及为何创建Search .NET版
ASP.NET十分有用的页面间传值方法
使用ASP.NET AJAX框架扩展HTML Map控件
AJAX使用技巧:如何处理书签和翻页按扭
.NET环境下几种不同的邮件发送解决方案
.NET vs J2EE——面对SOA的荒谬与误解
ASP.NET学习篇(1)——开篇
ASP.NET学习篇(2)——安装与配置
ASP.NET学习篇(3)——几个简单的ASP.ENT的例子
ASP.NET学习篇(4)——服务器端的控件
项目调试时出现用到的一个组件“访问被拒绝”的解决方法
ASP.NET中“找不到指定模块”的解决办法
采用Native 引导方式的.Net加密保护
“您无权查看该网页”的原因和解决方法
ASP.NET中Datagrid常见错误
编写ASP.NET应用程序的技巧
Scott Mitchell ASP.NET 2数据控件嵌套

ASP.NET 中的 Sandcastle介绍:生成.NET API文档的工具


出处:互联网   整理: 软晨网(RuanChen.com)   发布: 2009-09-28   浏览: 65 ::
收藏到网摘: n/a

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