• 关于我们关于我们
  • 海口企业网站建设电话0898-66611999 / 66611996 / 66611997
  • 海口企业网站建设电话400-8168-664
硕思科技  >>  建站技术  >> 

Sandcastle介绍:生成.NET API文档的工具(生成 文档 工具 介绍)

作者:海口硕思建站来源:海口网站建设发布时间:2013-12-14 11:33:48

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

4008-168-664  
返回顶部  
海南硕思云网络科技有限公司     地址:海南省海口市国贸大道海涯国际大厦19F
咨询电话:0898-66611999 / 66611997 / 66611996    全国免费电话:400-8168-664    企业QQ:466611999

2003-2018 Hisosi.Com  All Rights Reserved. 版权所有:硕思科技   

您好,硕思科技欢迎您的光临,请问有什么可以帮到您?