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

ASP.NET
asp.net ajax功能强大的UpdatePanel控件
mscorwks.dll在.Net中的地位及代码保护应用
使用.NET实现你的IP切换器
在ADO.NET中用参数化查询缩短开发时间
Login控件：用户登录失败的消息提示
如何用C#来部署数据库
.net打包自动安装数据库
数据库开发个人总结(ADO.NET小结)
ASP.NET如何进行性能优化问题(2)
ASP.NET如何进行性能优化问题(1)
用.Net实现基于CSS的AJAX开发(6)
用.Net实现基于CSS的AJAX开发(5)
用.Net实现基于CSS的AJAX开发(4)
用.Net实现基于CSS的AJAX开发(3)
用.Net实现基于CSS的AJAX开发(2)
用.Net实现基于CSS的AJAX开发(1)
C#下用P2P技术实现点对点聊天
ASP.NET服务器端异步Web方法
在asp.net中如何从视频文件中抓取一桢并生成图像文件
.NET中多线程的同步资源访问

No. « 1 2 3 4 »

技术文章搜索

关键字

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

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