Java文档注释导出帮助文档和项目的jar包导入和导出。

 

1.1      文档注释导出帮助文档

在eclipse使用时，可以配合文档注释，导出对类的说明文档，从而供其他人阅读学习与使用。

通过使用文档注释，将类或者方法进行注释用@简单标注基本信息。如@author 作者、@version代码版本、@param方法参数、@return方法返回值等。

package cn.itcast;
/**
 * 我的工具类
 * @author Li
 * @version 1.0版本
 */
public class Tool {
    /**
     * 返回两个整数的累加和
     * @param num1 第一个数
     * @param num2 第二个数
     * @return 返回累加和
     */
    public static int getSum(int num1, int num2){
        return num1 + num2;
    }
}

使用Eclipse导出javadoc文档即可，操作步骤如下图：

1.2      项目的jar包导入与导出

jar包是一个可以包含许多.class文件的压缩文件。我们可以将一个jar包加入到项目的依赖中，从而该项目可以使用该jar下的所有类；

也可以把项目中所有的类打包到指定的jar包，提供给其他项目使用。

l  导出jar包：即把项目中所有类，打包到指定的jar包中，步骤如下图：

l  导入jar包：即把指定的jar包，加入到指项目中，提供给项目使用。

导入jar包的过程是将jar包加入到项目的.classpath文件中去，让项目识别，便可以使用jar包中所有的.class文件类。以下是加入步骤：

         1：项目根文件夹下创建lib文件夹，用于同一管理所有的jar文件

         2：把jar文件复制到lib文件夹中

         3：右键点击jar文件，点击Build Path，选择Add to Build Path，此时查看项目根文件夹下的.classpath文件，发现新加入的jar包路径被配置到了该文件中。

说明可以使用jar包中所有类了。

l  注意：

         Jar包加入后，必须Add to Build Path才能使用

         Jar包加入后，加入的类也必须导包，如果加入的类其包名与现有类包名相同，则视作在同一个包下。(不常见)