接口写完了，那就要写文档方便交接，正好在前段时间发现一个挺不错的小软件，整理了一下分享给大家。接下来用一个简单的例子生成项目文档，步骤如下。

1、准备工作

准备工作会稍微麻烦点，因为需要将所有需要生成文档的代码或者方法处添加注释，并且以三斜杠“///”的方式添加注释。虽然前期可能会累点，但是后期伤害还是可以的，具体可参考如下格式：

2、生成XML文档

在项目上右键打开属性，在生成选项卡最后的输出模块中勾选XML文档文件，为其指定输出目录和XML文件名（默认是在项目的bin目录中），然后将项目保存并生成一下，项目生成成功后，会在指定目录下生成该XML文件。

3、安装SandcastleInstaller生成器。感兴趣的小伙伴可以下载下来试试。

4、因为帮助文档的格式是HtmlHelp1，因此需要安装htmlhelp。

5、打开文档生成器，点击File-New Project，新建一个文件，在弹窗中指定文件名保存即可。

6、在右侧的Project Explorer中右键Documentation Sources，点击Add添加XML文档和DLL文件。也就是步骤2中指定的路径和XML文件。

7、在Help File选项卡中为你的文档指定标题、名字，语言指定为中文，在最下方可根据需要勾选需要生成的代码的语法。

8、在Visibility选项卡中根据需要勾选，在Edit API Filter过滤器中根据需要勾选文件、类或者方法，默认是整个项目所有注释均生成文档，你可以取消掉一些，勾选自己想要给别人看的。

9、在Missing Tags中勾选文本是否高亮显示。

10、在Paths选项卡中为文档指定输出位置。

11、点击生成图标即可。

步骤比较简单，如果代码中的注释写的比较丰富，那这个文档是相当不错的。本来还想放个网盘的链接，结果头条不让放，那大家自己百度下载一个吧