使用 Sandcastle 生成 chm 帮助文档

在上篇文章（编写并生成文档注释）中，我们已经了解了如何为类型和成员编写文档注释，以及如何生成相应的文档注释文件。在本文中，将简单地介绍如何使用 Sandcastle 生成 chm 文档。

Sandcastle 是一个文档生成工具，可以用它生成 MSDN 风格的文档，既能够生成 chm 文档，也能够生成 MS Help 2.x 帮助文档。在此之前曾流行的 NDoc，其作者已经放弃更新。

首先到 CodePlex 下载并安装 Sandcastle，目前最新版本是 Sandcastle January 2008 Release。安装后 Sandcastle 会创建一个系统环境变量 DXROOT，不要删除，因为 Sandcastle 要用这个环境变量。注意，如果之前安装过 Visual Studio 2005 SDK（安装它就意味着安装了早期版本的 Sandcastle），请删除用户环境变量 DXROOT，否则将影响新版本的使用。安装完成后，可以到安装目录下的 Examples 文件夹中看一看，这里有一些示例，可以用于研究 Sandcastle 的用法。

然后，准备好你的程序集和文档注释文件，我使用的是上篇文章中创建的 Hello.dll 和 Hello.xml。

接着，到 Sandcastle 安装目录下，把 Examples\sandcastle 文件夹下的 build_sandcastle.bat 文件复制到你的文件夹下，和 Hello.dll 以及 Hello.xml 放在一起。

最后，打开命令行，进入到这个目录，输入：build_sandcastle.bat vs2005 Hello <回车>。后面会出现很多信息，等这个批处理程序结束后，能看到多出了许多文件和文件夹。如果中间没有出现问题的话，进入 chm 文件夹，将会看到一个 Hello.chm 文件，这就是我们最终想要得到的——帮助文档，打开看一看吧，是不是挺漂亮的。下面是截图：

转载于:https://www.cnblogs.com/netatomy/archive/2008/01/24/1050769.html

使用 Sandcastle 生成 chm 帮助文档相关推荐

使用 Sandcastle 生成代码帮助文档
使用 Sandcastle可以生成MSDN风格的帮助文档,生成的帮助文档既可以是chm文档,也可以是MS Help 2.x帮助文档. 1 下载并安装Sandcastle Sandcastle下载地址为 ...
Sandcastle 生成.NET API文档的工具
Sandcastle是一个微软发布的工具,它通过反射程序集中的源代码以及添加代码中的XML注释来创建 MSDN形式的API文档.在CodePlex中刚发布了Sandcastle的一个新版本. 这个工具 ...
Javadoc转换chm帮助文档的四种方法总结
使用jd2chm.exe方式无法完成,不晓得为什么. 所以用的javadoc2chm 方式,但是chm文档开头AllClass乱码, 用chmeditor修改就可以了点击Files 下的工具类文档. ...
doxygen html chm,使用Doxygen生成全中文的chm帮助文档
2010年曾经使用Doxygen生成全中文的chm文档.由于Doxygen生成的chm目录文件(index.hhc)本身是使用UTF-8编码的,而古老的chm编译器(HTML Help Worksho ...
让自己的代码生成对应的chm帮助文档
作者博客地址:http://blog.csdn.net/zhoufoxcn/article/details/4127799 为你的类库生成类似于MSDN的帮助文档 .net开发人员都知道大名鼎鼎的MS ...
CHM帮助文档的制作
2011年8月22日在学长的安排下,我学会了制作简单的CHM帮助文档,下面将这几天的学习心得和体会记下来以备将来的需要和其他人的学习. 1.在制作CHM文档的初期一开始,学长让我研究一下CHM E ...
FastAPI 自动生成的docs文档没法使用
FastAPI 自动生成的docs文档没法使用,当展开路径时候一直在转圈,具体就是这样这个是由于swagger-ui 3.30.1 中的bug导致,具体bug可以看这里我们可以通过在FastAPI ...
ASP.NET Web API 使用Swagger生成在线帮助测试文档
ASP.NET Web API 使用Swagger生成在线帮助测试文档 Swagger-UI简单而一目了然.它能够纯碎的基于html+javascript实现,只要稍微整合一下便能成为方便的API在线 ...
开发日记-20190328 关键词利用eolinker一键快速生成API接口文档
今天感觉效率真的很低= =各个层面的,apk发布到现场发现出现了问题,所以一个下午都在忙着解决现场出现的问题,领导一直打电话询问进度,午觉也没有睡所以今天预计的很多计划都处于停滞状态,像昨天规划的今天 ...

使用 Sandcastle 生成 chm 帮助文档

使用 Sandcastle 生成 chm 帮助文档相关推荐

最新文章

热门文章