Sandcastle安装指南

Sandcastle是微软开发的用于生成API文档的工具，常被称为帮助文档制作工具。

- Sandcastle目前已更新至v2015.10.10版本。

- 访问指定网址下载Sandcastle工具

- 下载后得到一个RAR格式的压缩文件

- 解压此压缩文件

- 将看到所示的文件列表

- 寻找可执行的exe文件

- 开始安装

- 进入安装页面

- 左侧详细列出了安装步骤

- 参照左侧步骤进行安装操作

- 按右侧说明逐步安装即可

- 起初为简要介绍

- 我们决定选用 next

- whats new中提供了当前最新版本的链接信息。

- 继续下一步

- 逐步详解安装流程

- whats new中提供了当前最新版本的链接信息。

- 继续下一步

- 进入.NET Framework相关设置项

- .NET Framework 是开发人员广泛熟悉和使用的开发平台。

- 版本需不低于4.5

- 我已安装 .NET Framework，可直接点击下一步继续操作。

- 若未安装 .NET Framework 将无法继续运行，必须先完成安装方可进行后续操作。

- 帮助文件的格式类型多种多样，常见于各类软件文档中。

- 帮助文档支持多种格式，详见列表。

- 如Markdown、OpenXML等格式。

- 我们继续下一步

- 在HTML Help 1编译器环境下进行文件编译处理操作过程。

- 检测系统是否安装了HTML帮助文件。

- 未安装软件时将显示提示信息

- 提供微软官方下载链接

- 我已将文件上传至网盘，供大家共享下载，链接为：http://pan.baidu.com/s/1gdO2gJh。

- 这里是建筑安装与生成工具的场所

- 即Sandcastle主体软件工具

- 务必安装这个

- SandcastleBuilderGUI 是其完整名称。

- 此时软件会自动检查系统中是否已安装SandcastleBuilderGUI组件。

- 未安装将提示进行安装

- 将弹出独立窗口用于主程序的安装。

- 选一条路，直接点击下一步即可。

- 从名称可看出，这是一款用于Visual Studio的插件。

- 目前仅支持Visual Studio 2013和2015版本。

- 可选安装，按需进行

- 如需安装，请点击底部的 install package 选项进行操作。

- 若未安装，点击下一步，系统将给出相应提示。

- 这只是一个提示，选择即可跳过。

- 同样是VS中的一个扩展功能

- 可选安装功能

- 同样是VS中的扩展功能

- 可选安装此功能

- 支持在Visual Studio中进行拼写检查功能。

- 为提升使用sandcastle for visual studio的准确性，需规范操作流程并完善配置参数。

- 至此，我们的sandcastle安装已顺利完成。

- 安装完毕即可启动软件使用

默认软件位置设于C：Program Files (xEWSoftwareSandcastleHelpFileBuilder，若未改变，将自动在此路径完成安装及设置。

- 查看图片，找到名为SandcastleBuilderGUI.exe的可执行文件。

- 启动程序

- 软件界面将随之显示出来

- 至此，安装工作已全部完成。