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

ASP.NET
ASP.NET在上传文件时对文件类型的高级判断的代码
JQuery运用ajax注册用户实例(后台asp.net)
Asp.net与SQLserver一起打包部署安装图文教程
asp.net 上传下载输出二进制流实现代码
asp.net(C#)解析Json的类代码
asp.net 截取字符串代码
asp.net ubb使用代码
asp.net XML文件操作实现代码
asp.net利用HttpModule实现防sql注入
ASP.NET(C#)中操作SQLite数据库实例
asp.net(c#)ref,out ,params的区别
asp.net(C#)防sql注入组件的实现代码
asp.net FCKeditor自定义非空验证
Asp.net TreeView来构建用户选择输入的方法 推荐
asp.net(C#)函数对象参数传递的问题
Asp.net中的GridView导出遇到的两个问题和解决方法
asp.Net 中获取一周第一天,一月第一天等实现代码
asp.net MaxLengthValidator 最大长度验证控件代码
C# 通用文件上传类
asp.net 自定义控件实现无刷新上传图片,立即显示缩略图,保存图片缩略图

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


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