Sandcastle：生成.NET API文档的工具

作者 Abel Avram 译者 赵劼 发布于 2008年2月4日

领域

语言 & 开发

主题

工件和工具 ,

.NET ,

工具 ,

敏捷 ,

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

译者 赵劼 网名为老赵，洋名Jeffrey Zhao，写有技术博客“老赵点滴”。关注前沿技术，并致力于开源社区与微软平台的组合优化。

1. 返回顶部

   勘误

   发表人 Shichao Liu

   声称->生成
   
   另外貌似这个项目停了呢,又过了一年,还是当年那个CTP

   回复