依据开源项目的源码生成对应的帮助文档
2017-07-10 09:48
381 查看
如今市场上。开源的项目越来越多,可是项目尽管开源。可是非常多相关的文档却须要我们花钱购买。假设不购买,我们就一定不能获取对应的帮助文档吗(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窗体命令:
该命令执行之间。会有一分钟左右的时间电脑不会有不论什么的反应。所以在这个阶段大家一定要耐心等待。
命令窗体执行完成之后会有对应的提示信息,我们的目录内页会出现这种文件。也就是我们所须要的帮助文档:
这样我们就大功告成了,仅仅要有开源的项目代码,我们就能够生成对应的帮助文档,所以妈妈再也不用操心我的学习!
以下就教大家一起使用源码生成帮助文档:
※
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窗体命令:
该命令执行之间。会有一分钟左右的时间电脑不会有不论什么的反应。所以在这个阶段大家一定要耐心等待。
命令窗体执行完成之后会有对应的提示信息,我们的目录内页会出现这种文件。也就是我们所须要的帮助文档:
这样我们就大功告成了,仅仅要有开源的项目代码,我们就能够生成对应的帮助文档,所以妈妈再也不用操心我的学习!
相关文章推荐
- 根据开源项目的源代码生成相应的帮助文档
- 将Android项目打包成jar与生成对应的api帮助文档(也就是注解)
- 将项目打包成jar与生成对应的api帮助文档(也就是注解)
- [置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用
- enterprise architect (EA) 源码生成UML类图,帮助理解项目工程
- 让自己的代码生成对应的chm帮助文档
- SQL Server 数据库文档生成工具开源项目【合作邀请】
- GDAL源码剖析(三)之Swig编译和帮助文档生成
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- .NET平台开源项目速览(4).NET文档生成工具ADB及使用
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- 使用eclipse 生成自己项目的API帮助文档
- GDAL源码剖析(三)之Swig编译和帮助文档生成
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 通过Struts源码生成chm格式帮助文档
- 通过struts提供的源码生成chw帮助文档
- enterprise architect (EA) 源码生成UML类图,帮助理解项目工程
- 由struts源码生成帮助文档
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm