使用Sandcastle 基于代码注释生成接口文档

一. 工具下载：

1. Sandcastle：Sandcastle是微软官方的文档生成工具，下载地址：http://www.codeplex.com/Sandcastle  

2. SHFBGuidedInstaller：Sandcastle结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单。下载地址：http://shfb.codeplex.com/

分别安装以上两个工具后，打开 Sandcastle Help File Builder  GUI

选择File->New Project

找一个位置保存我们的配置文件，通常放在我们的项目的根目录下，保存成功后，如图：

接下来，我们就添加我们的DLL文件了，添加之前，我们要在我们的代码中添加注释，及配置生成XML文档

在Documentation Sources上右键，Add Documentation Source,找到我们刚生成的XML文件（DLL文件也行 它会自动把两个文件同时加入进来）

添加 成功后，我们就开始配置中间的部分：

首先看Build，它让我们选择生成什么样的文档，默认勾选第一个，但是CHM文档需要单独安装一个东档，先不管它，我们先生成website的就可以了。

在Help File中，我们要注意以下几项： 语言选中文，Presentation style这个没用，我的vs是2017，它连个选项都没有，应该还支持2017， 

include root namespace container要勾选，否则只生成一个命名空间的文档。

其它的配置，根据需要写。

 

 在Summaries,里配置要生成文档的命名空间：

 

 其它的配置 省略。。。

最后点击build 

 

注释文档就生成了。

 

转载于:https://www.cnblogs.com/hankuikui/p/7724322.html