Sandcastle 生成.NET API文档的工具

最新推荐文章于 2022-06-05 12:02:59 发布

dianxi7005

最新推荐文章于 2022-06-05 12:02:59 发布

阅读量140

点赞数

原文链接：http://www.cnblogs.com/yinhongwei/archive/2010/02/20/1669805.html

版权

Sandcastle是一款由微软开发的工具，用于通过反射和XML注释生成MSDN风格的API文档。该工具现已开源，可在CodePlex上获取。Sandcastle能生成与MSDN相似的文档，支持各种注释类型，兼容.NET2.0框架，并能生成多种格式的文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

转载于:https://www.cnblogs.com/yinhongwei/archive/2010/02/20/1669805.html