码迷,mamicode.com
首页 > 其他好文 > 详细

根据开源项目的源代码生成相应的帮助文档

时间:2015-07-17 12:15:58      阅读:169      评论:0      收藏:0      [点我收藏+]

标签:java   生成文档   

     现在市场上,开源的项目越来越多,但是项目虽然开源,但是很多相关的文档却需要我们花钱购买。如果不购买,我们就一定不能获取相应的帮助文档吗(PS:这里用struts2.2.1.1 作为示范的例子)?

    下面就教大家一起使用源代码生成帮助文档:

 1.使用MyEclipse建立一个新的项目,将struts的源代码放到其中,这时src文件夹下的org.开头的包都报错,不过不用担心,请继续向下看:

 2.将struts2.2.1.1  .jar文件中(除struts2.core之外)的所有jar包引入到建立的项目中:

      技术分享

 3.执行完第2步之后,大部分的错误会被解决,但是有两个遗留问题:httpRequest 和httpResponse缺少引用,所以第3步就是来解决这个问题的:

    使用和第2步相同的引用方式,将Tomcat 中的jsp-appi.jar 和servlet-api.jar 两个jar包引入到项目中,保存,这时整个项目将不再提示错误信息。一切就绪,我们可以开始生成工作了:

4.解决完所有的错误,我们开始生成阶段的工作:

        技术分享

      选择“Generate Javadoc”之后,在弹出的对话框中做如下选择:

        技术分享

     所有的操作完成后,点击“Finish”,查看Console选项卡中的信息,会呈现下图:

     技术分享

Console选项卡中的信息完成之后,将下载好的jd2chm.exe的应用程序拷贝到生成文档的所在文件夹内,运行cmd窗口命令:

     技术分享

该命令运行之间,会有一分钟左右的时间电脑不会有任何的反应,所以在这个阶段大家一定要耐心等待。命令窗口执行完毕之后会有相应的提示信息,我们的文件夹内页会出现这样的文件,也就是我们所需要的帮助文档:

技术分享

      这样我们就大功告成了,只要有开源的项目代码,我们就可以生成相应的帮助文档,所以妈妈再也不用担心我的学习!

  技术分享

版权声明:本文为博主原创文章,未经博主允许不得转载。

根据开源项目的源代码生成相应的帮助文档

标签:java   生成文档   

原文地址:http://blog.csdn.net/ysc1123/article/details/46922809

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!