写点什么

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

  • 2008-02-04
  • 本文字数:647 字

    阅读完需:约 2 分钟

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

查看英文原文: Sandcastle: Generate .NET API Documentation

2008-02-04 19:402478
用户头像

发布了 157 篇内容, 共 56.4 次阅读, 收获喜欢 6 次。

关注

评论

发布
暂无评论
发现更多内容

第三周总结

芒夏

极客大学架构师训练营

第 3 周 - 课后作业

大海

单虚拟机搭建kafka集群

Leonbond

kafka

单虚拟机搭建zookeeper集群

Leonbond

zookeeper

架构师训练营 第三周 学习总结

一雄

学习 极客大学架构师训练营 第三周

Week3 作业

TiK

极客大学架构师训练营

第三周学习总结

天之彼方

设计模式

「架构师训练营」单例与组合模式的应用

Amy

极客大学架构师训练营 作业 第三周

架构师训练营week03 总结

fujin

架构师 极客大学架构师训练营

第03周 重构软件代码 命题作业

Jaye

架构师训练营第三周作业

Java 极客大学架构师训练营

Week3 总结

TiK

极客大学架构师训练营

架构师训练营 - 第三周 - 学习总结

stardust20

架构师训练营第三周学习总结

不谈

极客大学架构师训练营

架构师训练营 第三周 作业

一雄

极客大学架构师训练营 作业 第三周

极客大学架构师训练营第三周学习总结

竹森先生

设计模式 极客大学架构师训练营

架构师训练营-W03S-代码重构

赤色闪电

极客大学架构师训练营

【架构训练 Week03 作业】Review

Rex

架构师训练营第三章作业

吴吴

【架构训练 Week03 作业】

Rex

第三周总结

大雄

架构师训练营第三周作业

Bruce Xiong

第三周-作业

铁血杰克

架构师训练营 -- 第三周作业

stardust20

架构第三周-学习总结

J.Smile

极客大学架构师训练营

10分钟带你入门git到github

root

Java git GitHub 版本控制

架构师训练营-W03H-代码重构

赤色闪电

极客大学架构师训练营

设计模式

ashuai1106

设计模式 架构师 极客大学架构师训练营 23种设计模式

第03周 重构软件代码 学习总结

Jaye

架构师训练营 - 作业 - 第三讲

吕浩

week3-作业一

Coder

Sandcastle:生成.NET API文档的工具_.NET_Abel Avram_InfoQ精选文章