自己动手创建开源项目的帮助文档

下面就以struts的帮助文档为例

在学习Java的时候我们曾经学习过,Java有很强大的注释功能,其中  /****/   这种注释可以用来生成文档,

更具这个思路,一个开源的项目,我们可以下载到他们的源文件,那么其注释应该是完整的,通过这些注释就能生成完整的apidoc文档。


下载最新的struts包:http://struts.apache.org/download

下载文档生成的辅助工具,我用的是jd2chm


准备工作完成

接下来开始升沉文档


一:找到struts的源代码的位置   \struts-2.3.15\src\core\src\main\java

二:在eclipse里面新建一个Java project  ,将struts源代码拷贝到src目录中

自己动手创建开源项目的帮助文档_第1张图片


三:我们看到代码复制进去后有一堆的错误,因为源代码所依赖的包还没导入,接下来我们倒入包,

所需的包就在下载的struts的文件里面  struts-2.3.15\lib   

选中工程=》右键=》Build path=》configure build path  =》在libraries里面=》add external jars

找到  struts-2.3.15\lib  Ctrl+A全部导入,这时发现红叉少了许多,找到剩下的错误文件的错误之处


因为我们这是一个java项目,所以当然不包含HttpServlet的依赖jar包,但是记得Apache的lib里面有需要的jar包,

继续Build path =>add external jars,导入 在apache-tomcat-6.0.36\lib目录里面的 jsp-api.jar 和servlet-api.jar

错误消除


四:在eclipse中  Project=》Generate javadoc


自己动手创建开源项目的帮助文档_第2张图片


五:得到文档的html文件,并将jd2chm文件放到文件目录下

自己动手创建开源项目的帮助文档_第3张图片

(如果电脑没有安装htmlhelper的话要先安装htmlhelper,htmlhelper.exe已经在jd2chm.zip里面了

六:打开命令行,cd到html文件目录中

自己动手创建开源项目的帮助文档_第4张图片


八:enjoy!


生成的文档:struts-2.3.15.chm



你可能感兴趣的:(自己动手创建开源项目的帮助文档)