使用Eclipse打包库
开发中经常使用一些框架,提供的Jar包与文档,下面我们来制作属于自己的框架。 就需要学会制作文档+jar包
1. 文档注释的制作
我们写好的工具类给提供给别人的时候,提供的是一般我们的类的clas文件。但是我们知道在编译阶段,注释不会编译进class文件。为了更好让别人使用你的工具,就应该提供注释,这就是文档注释制作的最终目的。
1.1文档注释
我们开发中常见的注释
- 单行注释
- 多行注释
文档注释的写法
/**
*
*/
比如我写了MathUtils类,用来求和的工具类
/**
* @author coderhong
* @version 1.0
* 类GetSum实现整数求和
*/
public class MathUtils {
/**
* 方法getSum功能计算两个的整数和
* @param num1
* @param num2
* @return 返回和
*/
public static int getSum(int num1, int num2) {
return num1+num2;
}
}
如果安装了JDK,里面提供的工具javadoc
可以生成文档,聪明的我们怎么会使用命令呢,直接使用Eclipse生成。
注意:javadoc只识别文档注释
1.2 使用Eclipse生成注释文档
选择我们的项目,右键
Snip20171105_64.png
选择 Java--->javadoc 然后 Next
Snip20171105_65.png
选择要生成哪个类的注释
Snip20171105_66.png
本来可以直接点击Finish就OK了,在制作的过程中发现了浏览器打开文档注释乱码情况,这里点击Next 需要多一步
在最后一步VM options输入
-encoding UTF-8 -charset UTF-8
Snip20171105_67.png
点击Finish完成 查看生成文档目录
Snip20171105_68.png
点击index.html预览
Snip20171105_69.png
这样文档注释就制作完成了。
2. 使用Eclipse制作Jar包
我们提供给别人使用,提供的是编译的class文件,可能我们一个库中包含上百个类,就需要将这些class文件打包成一个文件,方便提供。这个文件就是Jar包。
JDK也提供了工具jar
,我们使用Eclipse来生成。其本质也是使用jar
命令。
右键,项目
选择
JAR file
Snip20171105_70.png
配置生成jar包的信息
Snip20171105_71.png
点击Finish 生成的jar
Snip20171105_72.png
使用解压缩工具解压查看里面的内容
Snip20171105_73.png
可以看出里面就是我们选择类的class文件。
好了,通过上面的讲解,你就可以自作自己的库提供给别人使用了。
网友评论