帮助文档生成

来源:互联网 发布:赵薇背后的势力 知乎 编辑:程序博客网 时间:2024/06/03 17:13

对开源代码自己创造制作帮助文档(.chm),对于网上许多开源代码没有帮助文档,我们可以自己手动生成帮助文档。

以一个实例来说明此方法
步骤如下:以生成struts2帮助文档为例


1.新建java项目,并将源代码复制到src中

 如:E:\圣思园 视频学习\struts\struts-2.3.24.1-all\struts-2.3.24.1\src\core\src\main\java路径下的org文件复制到src中,

2.这是会出现很多错误提示,因为这些类,应用了很多jar包,需要导入这些jar包

 如:将struts2安装路径lib目录下的所有jar包全部添加进来(除了struts2_core.jar),添加方式是:build Path-》configure build path-》 library下添加外部文件找到刚才选中的的那些jar包,添加进来。


3.如果来由错误提示,继续消除错误,

因为调用了httpServlet,所有还需要添加一个Servlet-api的jar包,我们可以在tomcat的lib目录下找到这个jar包,同时在将jsp-api.jar也添加进来,添加方式和上面的一样。


4.接下来是关键的一步。

 1)新建一个文件,用来保存接下来生成的帮助文档。
 2)选中项目名称,选择project中,选择Generation Javadoc,出现的抽口中,选择struts_doc;destination中填写刚才新建的那个文件。
 3)next,Document title 中填写名称Struts2 2.3.24
方框中,选择select all
 4) 点击next,finish时会提示是否更新,是否均可以。接下来节等待成功了。


5.在目标文件夹中就已经生成了,点击index就可以查看网页版的帮助文档,接下来我们再生成chm格式的。


6.使用我们的帮助文档生成工具即可。(jd2chm.exe)

 1)将jd2chm.exe复制到目标文件中。(在这之前需要安装觉得出门一起下载的htmlhelp.exe)
 2)doc 窗口进入到该文件中,执行jd2chm.exe
 3) 然后一次输入项目名称struts2 2.2.34,项目名称,注意前面不要有空格。
 4) 过几秒中就会开始执行,最后显示thanks表示成功。在文件中就可以看到生成的chm格式的帮助文档。

这时候就算大功告成,可以在自己生成的帮助文档中查询,搜索了。

0 0
原创粉丝点击