将C#项目生成chm帮助文档

最近在重构项目基础模块，顺便写一下帮助文档，发现有工具可以生成chm文档，和大家分享一下。

最近在重构项目的基础模块，想着写一下帮助文档。一时间无从下手，项目的基础模块还是本科时参与的，好多东西都记不清了。看到代码的第一反应就，这是我写的吗？什么时候写的来着？这个接口干啥的来着？哈哈，相信小伙伴看以前自己写的项目都是这种感受吧，当时太年轻，不习惯写注释。现在终于体会到当年老师说的，一定要写注释，一定要写注释，一定要命名规范。命名倒是还可以，还是当年太青涩，懒得写注释，自己留下的坑还能怎么办，自己填呗。

一、Sandcastle工具

Sandcastle是微软官方的文档生成工具，NDoc开发停止后，这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档，支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合Sandcastle Help File Builder可视化工具，整个生成过程十分简单。

二、前提

规范的注释、具体参考：

https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments

三、步骤

1.下载最新的Sandcastle后安装：

https://archive.codeplex.com/?p=sandcastle

2.然后下载 Sandcastle Help File Builder. 进行安装，根据提示将需要安装的插件全部安装成功，如果不知道可以选择默认：

https://archive.codeplex.com/?p=shfb

3.安装完成后直接新建项目 

新建项目，新建之后会看到一个 project Properties的菜单，这里我以 C#帮助文档为例， 

选择 Help File 主要是红色区域的部分，选择之后在最右边部分，选择需要添加的 文件， 将dll文件和其对应的xml文件添加到项目中，右键add