Sandcastle - 生成.NET API文档的工具
2008-08-29 12:31
369 查看
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+Html work shop + Sandcaste help file builder使用:
参考:http://blogs.msdn.com/sandcastle/
下载Sandcastle(TCP),HTML Work Shop,Sandcastle Help File Builder 并安装。
http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
http://www.codeplex.com/SHFB
http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx?ReleaseId=13873
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+Html work shop + Sandcaste help file builder使用:
参考:http://blogs.msdn.com/sandcastle/
下载Sandcastle(TCP),HTML Work Shop,Sandcastle Help File Builder 并安装。
http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
http://www.codeplex.com/SHFB
http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx?ReleaseId=13873
相关文章推荐
- 一个生成.net api文档的工具sandcastle
- Sandcastle:生成.NET API文档的工具 (帮忙文档)
- Sandcastle 生成.NET API文档的工具
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm
- 用Sandcastle生成.net项目API文档
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm
- GhostDoc:生成.NET API文档的工具 (帮忙文档)
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- C# CHM帮助文档生成工具-Sandcastle
- [导入].net 文档生成工具(.Net 2.0) 源代码
- .Net开发必备十大工具详解之用微软Sandcastle创建.NET文档
- API文档自动生成工具
- 工具:使用过的 API 文档生成工具
- .net中使用Sandcastle(类似java中的jdoc)生成代码帮助文档
- Flex AsDoc 文档API生成工具 可以生成和Adobe的ActionScript3帮助一样的文档 .
- Flex AsDoc 文档API生成工具 可以生成和Adobe的ActionScript3帮助一样的文档
- Api文档生成工具Swagger集成说明
- Flex AsDoc 文档API生成工具(方法2)