繁體中文当前位置: 首页 > 图文教程 > 网络编程 > ASP.NET > Sandcastle介绍:生成.NET API文档的工具
- ASP.NET
- 从ASP.NET的PHP执行速度比较谈起
- 基于ASP.NET2.0的非HttpModule山寨版MVC框架的实现
- ASP.NET 中公有的六种验证控件
- 无废话C#设计模式之八：Facade
- C# 中的 @ 符号的使用及注意事项
- 保护你的.Net代码：谁动了我的组件？
- VS2008与.NET 3.5的JS智能感知和调试
- 关于 .Net 开发下的分布式缓存设计
- 在C#3.0中使用扩展方法来扩展接口
- C#实现Windows 服务的制作安装和删除
- C#3.0中实现隐式类型变量、匿名类型的方法
- C#代码与javaScript函数的相互调用
- 构建 ASP.NET AJAX 开发环境
- Windows 窗体的.Net 框架绘图技术
- .NET 开发中的一些小技巧集锦
- ASP.NET 2.0 创建母版页引来的麻烦
- .NET Compact Framework 概述
- .NET Compact Framework 2.0 SP1新增功能
- 专家访谈：从Web 2.0到Web 3.0
- .Net里漂浮窗口拖动的实现方法
ASP.NET 中的 Sandcastle介绍:生成.NET API文档的工具
出处:互联网 整理: 软晨网（RuanChen.com） 发布: 2009-09-28 浏览: 39 ::
收藏到网摘: 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位的机器上使用。
评论 (0) All
