繁體中文当前位置: 首页 > 图文教程 > 网络编程 > ASP.NET > Sandcastle介绍:生成.NET API文档的工具
- ASP.NET
- 漫谈.Net开发关于命名空间和目录划分
- .net中关于企业Excel报表的生成
- .NET中取得IP/用户名等信息常用方法
- 关于.Net开发下的分布式缓存设计
- .NET中为组合框添加自动查询功能
- ASP.NET如何进行性能优化问题
- 开发中如何有效监控.NET应用程序
- ASP.NET2.0 显示写入日期和时间语法
- 用.NET Array类的Sort方法分类数值
- Asp.net Mvc Pv4中使用AjaxHelper
- Asp.net中Forms验证的角色验证授权（一）
- Asp.net中Forms验证的角色验证授权（二）
- Asp.Net2.0数据库基本操作方法学习
- Asp.Net之枚举类型输出需要类型转换
- 用.NET的File控件上传文件的解决方案
- .NET泛型技巧之类型参数之间的转换
- 在ASP.NET中将数据直接输出成Excel格式
- 在.NET框架下使用自定义配置设置
- 跟ASP.NET MVC一起使用jQuery
- Visual Basic中文本框处理技巧集萃
ASP.NET 中的 Sandcastle介绍:生成.NET API文档的工具
出处:互联网 整理: 软晨网（RuanChen.com） 发布: 2009-09-28 浏览: 166 ::
收藏到网摘: 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
