⾃⼰动⼿创建开源项⽬的帮助⽂档
下⾯就以struts的帮助⽂档为例
在学习Java的时候我们曾经学习过,Java有很强⼤的注释功能,其中 /****/ 这种注释可以⽤来⽣成⽂档,
更具这个思路,⼀个开源的项⽬,我们可以下载到他们的源⽂件,那么其注释应该是完整的,通过这些注释就能⽣成完整的apidoc⽂档。
下载⽂档⽣成的辅助⼯具,我⽤的是
准备⼯作完成
接下来开始升沉⽂档
⼀:到struts的源代码的位置 \struts-2.3.15\src\core\src\main\java
⼆:在eclipse⾥⾯新建⼀个Java project ,将struts源代码拷贝到src⽬录中
三:我们看到代码复制进去后有⼀堆的错误,因为源代码所依赖的包还没导⼊,接下来我们倒⼊包,
所需的包就在下载的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
五:得到⽂档的html⽂件,并将jd2chm⽂件放到⽂件⽬录下
(如果电脑没有安装htmlhelper的话要先安装htmlhelper,已经在⾥⾯了)六:打开命令⾏,cd到html⽂件⽬录中
jsp帮助文档
⼋:enjoy!
⽣成的⽂档:
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论