繁體中文当前位置: 首页 > 图文教程 > 网络编程 > ASP.NET > Sandcastle介绍:生成.NET API文档的工具
- ASP.NET
- .Net技术开发中两个“属性”引起的歧异
- 技术文档：解读.Net虚拟框架的实现原理
- .Net课堂：总结必须学习的10项.NET技术
- 实现MSMQ消息加密的安全实践
- C#中对DatagridView的部分常用操作
- .Net基础：了解ASP.NET中的IFRAME框架挂马
- ASP.NET中显示Linq To SQL输出的SQL语句
- 链表的顺序表示和实现（C++模板类实现）
- 如何在ASP.NET项目里面正确使用Linq to Sql
- ASP.NET两个截取字符串的实用方法技巧
- 一个简单程序的反编译
- ASP.NET MVC中你必须知道的13个扩展点
- Entity Framework的默认值BUG解决方法
- C#中通过Assembly类访问程序集信息
- Java与.NET间进行Web Service交互的选择
- C#中用鼠标移动页面功能的实现
- 程序员的信仰
- ASP.NET多附件上传和附件编辑的实现
- 菜鸟课堂：在Visual C# .NET中跟踪和调试
- IronPython和C#执行速度对比
ASP.NET 中的 Sandcastle介绍:生成.NET API文档的工具
出处:互联网 整理: 软晨网（RuanChen.com） 发布: 2009-09-28 浏览: 155 ::
收藏到网摘: 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
