Sandcastle引见:生成.NET API文档的工具

Aiyiweb.Com提示：Sandcastle是一个微软发布的工具，它通过反射程序集中的源代码以及添加代码中的XML注释来创建MSDN方式的API文档。在CodePlex中刚发布了Sandcastle的一个新版本。

 

　　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位的机器上使用。

转载：http://www.aiyiweb.com/sitecn/aspnet/13971.html

转载于:https://www.cnblogs.com/BBDD/archive/2013/05/02/3054364.html