利用SandCastle生成帮助文档.docx

Sandcastle入门：创建C#帮助文档 今天学到了一个东西：利用vs2005生成的dll/xml来生成帮助文档。完成这个伟大任务的是Sandcastle，微软推出的类库文档编译工具。在开始这篇笔记之前，我想先感谢我文后提及的七篇关于Sandcastle的文章。是它们出色的阐述使得我能够整理出这篇笔记，之前我从未接触过。对于那七篇文章，我努力寻找它们的源出处链接，然而网络的传播性使得这些一再被转载的文章逐渐模糊了它们的来源，有一些是我无法确定的。因此，我希望，如果这篇文章有幸能被您转载，请注明转载和出处，谢谢。o(∩_∩)o…　(瑶瑶按：由于本文较长且从word移植到baidu的诸多不便，本文将分成3个部分分别发布）　目录========================================================================　1. 名词解释：Sandcastle---------------------------------------[1]　2. Background---------------------------------------------------[1]　3. Sandcastle Overview-----------------------------------------[1]　4. 使用Sandcastle-----------------------------------------------[2]　4.1 使用平台　4.2 使用方式（可选界面）　4.3 资源下载5. 生成文档步骤------------------------------------------------[3]　5.0 使用命令行方式　5.1 Sandcastle Help File Builder　5.2 SandcastleGUI　5.3 Sandcastle CHM编译BAT脚本和配置实用工具　5.4 DocProject　6. References----------------------------------------------------[3]　========================================================================1.名词解释：Sandcastle========================================================================Documentation compilers for managed class librariesEnabling managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel.========================================================================2.Background在微软推出Sandcastle之前，人们倾向于选择开源的NDoc（.NET代码文档生成器）。NDoc可以将 C#.NET 编译生成的程序集和对应的 /doc XML文档，自动转换成如 .NET Framework SDK 类库文档或者 MSDN Library 在线 .NET 类库文档形式的代码文档：然而遗憾的是，这个项目由于资金等问题，作者Kevin于2006年7月宣布不再投入NDoc开源项目的开发，NDoc停留在1.3的历史版本，无法完全支持.NET 2.0，将渐渐淡出人们的视野。在发布VS2005之前，MS内部开发了一个用于生成帮助文档的工具。这就是Sandcastle的前身。但是当时编译一次文档就需要十多个钟头，这使得这个工具可用性不强。后来发布的Sandcastle由于做了很大的优化，就只要30分钟了。当然，现在的Sandcastle经历了几个CTP版本的测试已经比较成熟了。（Ref[1]，有增删）（注：CTP，Community Technology Preview）。Sandcastle目前（2007年10月30日）为止必威体育精装版的版本是September 2007 CTP，version 2.3.07930.06，2007年10月1日发布。（瑶瑶按：在写这篇日志的过程中，MS发布了新的Sandcastle版本October 2007 CTP，version 2.3.8000.26，2007年10月29日发布。相应地后面提到的Sandcastl