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包加入后，加入的類也必須導包，如果加入的類其包名與現有類包名相同，則視作在同一個包下。(不常見)