帮助文档制作工具 Sandcastle安装步骤

帮助文档制作工具 Sandcastle安装步骤

Sandcastle是微软推出的帮助文档制作工具也就是我们常说的API文档了

我们平常见到的.chm的就是帮助（API）文档了

全称为Sandcastle Help File Builder

这是一款开源免费的工具

使用这款工具可以帮我们制作常用的帮助（API）文档

配合visula studio开发工具就更加快捷好用了

Sandcastle更新到现在版本为v2015.10.10

根据网址下载Sandcastle

下载下来是一个rar的压缩包

解压缩这个压缩包

就会看到如下图的这些文件

找到exe的可执行文件

执行安装

进入到安装界面

这里的左侧给出了很详细的安装步骤

我们可以根据左侧的安装步骤

和右侧的说明 一步一步的来安装

刚开始是一些简介

我们选择 next

what's new中是给出了目前最新版本的连接

继续next

我们来一步步的说明安装步骤

what's new中是给出了目前最新版本的连接

继续next

进入到.net framework一项

这里要求我们必须要安装.net framework

.net frameork对于开发人员来说都是非常熟悉的了

这里的版本要求是至少4.5

我这里已经安装了.net framework 所以可以继续选择next

如果你没有安装.net framework 是不能继续的 必须要安装.net framework

在help files formats

中列出了帮助文档支持的几种格式

比如markdown，openxml等

我们继续next

在html help 1 complier中

会检测你系统中是否有安装html help

如果没有安装软件会给出提示

并且会给出微软的下载地址

我也有上传到网盘共分流http://pan.baidu.com/s/1gdO2gJh

这里是安装建制和生成工具

也就是 Sandcastle主软体

这个一定要安装

全名是SandcastleBuilderGUI

进行到这一步时，软件也会检测你是否安装了SandcastleBuilderGUI

没有安装则会提示你安装

这里会单独给出一个安装窗口来单独安装主软体

选择一个路径直接下一步就可以了

看名字就知道这是要安装到visualstudio的插件了

目前仅支持vs2013和vs2015

这个是可选的安装了

如果想要安装就可以选择底部的 install package

如果没有安装就选择next 这里也会给一个提示

不过这个仅是一个提示而已 选择是就可以跳过

同样是一个vs中的拓展功能

此功能可选安装

同样是一个vs中的拓展功能

此功能可选安装

支持visual studio中的拼写检查

为了提高我们使用sandcsatle for visual studio时的正确性

到了这一步就说明我们的sandcastle已经安装完成了

安装完成后就可以运行软件了

该软件默认的安装位置是C:\\program files(x86)\\EWsoftware\\Sandcastle Help File Builder中

看图找到SandcastleBuilderGUI.exe

运行软件

就会显示出软件出界面了

到此我们的安装就算完成了