使用SandCastle生成代码注释文档

应用场景

好的代码即文档，好的代码，从文档的层面指的是功能明确、分类清晰，注释完整且清楚，便于阅读维护。开发人员也常常面临撰写详细设计文档的工作，如果平时的开发过程当中，对代码中的注释写的已经很清晰明了了，则完全可以提取出来作为文档的一部分。

下面介绍一款代码注释文档生成工具SandCastle，可以生成专业的chm格式。

下载安装包

SandCastle：http://sandcastle.codeplex.com/
        SandCastle Help File Builder：http://shfb.codeplex.com/

如何使用

打开程序：Sandcastle Help File Builder GUI

新建一个SHFB项目

在Documentation Sources上点击右键，把需要生产代码文档的项目、工程、dll、或整个解决方案文件，添加进来。

设置项目属性

设置输出路径、Html Helper编译路径、SandCastle主程序路径：

在Documentation菜单下单击Build Project。 完成后，会在指定的输出目录下生成相应的文档以及日志，如果没有生成成功，可查看LastBuild.log来分析错误原因。

生成的专业的代码注释文档：

注意：如果生成失败，请先检查项目属性，是否设置了XML文档输出。