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

ASP.NET
Visual Basic .NET处理Excel表格全接触
ASP.NET缓存方法分析和实践示例
.NET Framework 新功能和增强的功能
ASP.NET MVC :MVC页面验证与授权
URL的传递字符串问题小研究
.NET程序员新方向 Ruby核心语法入门
Asp.net教程:设计IP地址屏蔽功能
asp.net中的观察者模式
ASP.NET网站程序防SQL注入式攻击方法
ASp.Net自定义验证码控件
ASP.Net开发新手常见问题备忘录
.net解决数据导出excel时的格式问题
让.Net 应用程序突破2G的内存访问限制
asp.net 获取客户端IP与mac
用ASP.NET创建网络相册 保存美好时光
创建基于ASP.NET的SMTP邮件系统
在ASP.Net 中实现将图片存入数据库
经典ASP.NET打印技术
详细解读.NET中的代码动态编译
如何在VC中实现淡入淡出的启动画面

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


出处:互联网   整理: 软晨网(RuanChen.com)   发布: 2009-09-28   浏览: 56 ::
收藏到网摘: 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位的机器上使用。