Quote:Sandcastle, created by Microsoft, is a tool used for creating MSDN-style documentation from .NET assemblies and their associated XML comments files. The current version is the May 2008 release. It is command line based and has no GUI front-end, project management features, or an automated build process like those that you can find in NDoc. TheSandcastle Help File Builderwas created to fill in the gaps, provide the missing NDoc-like features that are used most often, and provide graphical and command line based tools to build a help file in an automated fashion.
Sandcastle是一个由微软制作的,依赖.NET程序集及其相关的XML文件生成MSDN形式的文档帮助的工具,现在最新的版本是2008月5月发布的。通过这个工具可以方便地制作出帮助文档,但她是基于命令行的,没有GUI前端界面,项目管理功能,或你可以在NDoc中可以找到的自动生成功能,而Sandcastle Builder填补了Sandcastle的空白,提供了缺失的类似于NDoc提供的功能,并提供了基于图形和命令行的工具来自动建立一个帮助文件。
这次项目的过程中就俺也使用了Sandcastle Builder,主要是用来生成项目中的API帮助文档,小记一下:
使用步骤:
一、建立一个叫Hello的类库,象征性的建立一个HelloWorld类,在类中写个Test方法,并给上一些Summary标签注释, 随后进入项目属性中的生成选项设置
上面已经提到Sandcastle Builder要有XML文件的配件支持,所以这里要在项目输出栏选中XML 文档文件,保存即可。
2、F6编译项目,就可以看到在Debug目录下找到DLL和XML文件了,下面该Sandcastle Builder登场了。
3、首先在Sandcastle Builder的Documentation Sources里面添加DLL和XML文件。
4、随后就进行一些需要的设置好了,常见的都用黑体标出,当然,如果FrameworkVersion不符合的话还需要设置一下,这个是2008年发布的,所以就别期望能够支持到4.0了哈^_^
5、因为要配合微软的另一款HTML Help Workshop工具,所以这里要设置它的路径,最后指定输出目录和Sancastle的目录就好了
6、看一下Build之后的目录文件:
打开看一下效果:
效果不错,很实用的东西^_^
from:
http://www.cnblogs.com/RockyMyx/archive/2010/04/30/Project-Route-Using-SandcastleBuilder.html