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 位的机器上使用。
暂无签名
腾讯云云原生提质增效实践精选集 2024
《2024腾讯云云原生提质增效实践精选集》出炉，5大热门技术领域，13个行业精选标杆案例，痛点到解决方案全...
宁德核电基于大模型的AI讲师开发实践
小米数据湖架构演进：Iceberg、Paimon 与 AI 场景下的实践
基于大模型的缺陷静态检查
评论