什么是Sandcastle?
具体的信息在这里可以看到
在发布VS之前MS内部开发了一个用于生成帮助文档的工具这就是Sandcastle的前身但是当时编译一次文档就需要十多个钟头——好家伙真是够长当然后来发布的Sandcastle由于做了很大的优化就只要分钟了(看得出来MS内部的开发流程也是十分Agile的现有成果然后才作重构和优化的)
当然现在的Sandcastle经历了几个CTP版本的测试已经比较成熟了
Sandcastle同NDoc的比较
由于NDoc项目终结了所以一直没有机会达到NET 完全支持的地步另外NDoc还是MSDN 的风格同VS漂亮的样式稍有差距但是下面这些特点是Sandcastle一直缺乏的
JavaDocLaTeX的支持这个也不知道会不会在后期加入我特别喜欢的就是LaTeX的支持NDoc生成的LaTeX文档十分的漂亮
官方的GUI工具现在我使用的GUI工具还是Sandcastle Help File Builder(SHFB)MS官方仅仅提供了全部的命令行工具
将来似乎会被加入到VSSDK里头这样想仅仅安装Sandcastle似乎就麻烦了一点
我的选择
今年月之前我一直使用的是NDoc很显然CBC还处于NET 的平台上面
NDoc的工作就很好了但是面临着NDoc没有更新的情况我迟早也会转入Sandcastle的上面促使这一个过程加速的重要原因就是SHFB了由于这个界面同NDoc别无二致隐藏了全部细节十分方便NDoc的用户转到这一新的工具上面另外由于该工具还提供十分方便的命令行版本可以集成到NAnt或者MSBuild脚本中所以我还不犹豫的将CBC的文档全部放心的交给了它来处理