前言:最近一个科研项目上需要一个详细设计文档,就是把所有的类用的所有的方法整理成一个文档,不仅要有图表,还要有算法。做科研项目是真心累,要的功能倒是不复杂,但是文档却要写的很复杂,真的令人无奈。一个系统如此多的类,每个类中又有如此多的方法,要是一个个写起来,那真是令人伤透脑筋。于是网上搜了一下,微软还真的出了这么一个功能软件,这里记录下使用过程。
1.首先要安装两个软件,一个是 Sandcastle Help File Builder,简称SHFB,下载链接为
SHFB;另一个是Sandcastle,下载链接为
Sandcastle下载链接1
Sandcastle下载链接2。
2.SHFB安装完后,首先要创建一个工程。
3.在vs中右键项目-属性-生成,勾选保存xml,路径默认。然后重新生成。
4.在SHFB中右上角右键,添加源和引用相关内容。
5.在SHFB的Project Propertys选项卡中设置要生成的chm文件路径和名称,以及调用相关程序的路径,其中最重要的一点就是path中的HTML Help1 compiler path,要设置成我们在第一步中安装的Sandcastle的路径,否则会报错,找到生成工具。说白了就是SHFB调用的是Sandcastle的生成工具。
6.完成之后,我们就会得到一个chm文件
7.如果想把chm文件转换成word的话,可以使用chm2word,自行百度安装。
参考链接:
https://blog.csdn.net/archielau/article/details/12030211
https://www.cnblogs.com/liuyuqing/p/4137522.html
http://www.cnblogs.com/luckly-hf/p/3300815.html