SHFB-Sandcastle Help File Build vs文档生成工具安装及配置

SHFB-Sandcastle Help File Build vs文档生成工具安装及配置

1 该软件使用较简单，列出重要步骤，部分省略

2 软件安装

2.2.1 安装包
SHFBGuidedInstaller_2014.5.31.0.zip  下载地址  http://download.csdn.net/detail/huwei2003/9531584
2.2.2 安装
点击SandcastleInstaller.exe 按提示安装即可

3 软件使用

3.1.1 前提要求
第一：把生成帮助的工程的属性做下修改，右键工程，属性，生成，下面的输出框中有一个生成XML文件选项,打勾。文件会把工程中所有类，方法，属性上的注释保存下来。

第二：属性的注释。这个是最简单的，一般有summary块就行了，其中有一个value块，可以针对默认值进行描述。方法，接口的注释类似，在summary块对方法的用途，参数进行说明。

如下：

        /// <summary>
        /// 方法说明
        /// </summary>
        /// <param name="arg1">参数说明</param>
        /// <returns>返回说明</returns>
        /// <remarks>
        /// 备注
        /// </remarks>
        /// <example>
        ///    <code>
        ///      如何调用举例
        /// </code>
        /// </example>

public string GetString(string arg1)

{

...

}

3.1.2 建立工程
3.1.2..1 Build 项设置




3.1.2..2 Help File 设置
 设置相应信息即可

3.1.2..3 Help1/Website 设置
  设置相应信息即可

3.1.2..4 MS Help 2设置
无须设置

3.1.2..5 MS Help Viewer 
无须设置

3.1.2..6 Summaries
无须设置

3.1.2..7 Visibility
这里可以定义你要生成文档的方法定义，哪些要生成，哪些不要生成，下面的edit api filter 可以设置更详细的内容，如哪个命令空间下的不要生成，哪个类的不要生成，勾选上的是要生成的

3.1.2..8 Missing Tags
 
 设置相应信息即可

3.1.2..9 Paths


 

1 在右上角 点击 documentation sources 添加要生成文档的源工程 ,选择对应的dll,文件.如下图：
 
2 设置文档输出路径，及工作临时路径，如上图；


3.1.2..10 Commponents


3.1.2..11 Plug-Ins
无须设置
3.1.2..12 Transform Args
无须设置


3.1.2..13 Transform Args
无须设置


3.1.2..14 User Defined
无须设置


3.1.2..15 Build Events 
无须设置


3.1.3 生成
设置完成后，点击Documenttation – build project即可生成文档
 

生成的文档大致如下图
 

非常好的一点是 生成的项目文件 webapi.shfbproj 可以在teamcity(自动构建工具)中利用MSBuild 来自动生成文档，teamcity的介绍将在另一篇中介绍。