Netbeans 手動加入javadoc的jar擋

由於筆者最近需要用Netbeans寫Java (不能用Eclipse不習慣啊QAQ)，又寫Java的時候沒辦法在IDE上即時看doc真的很煩，只好抽時間來研究一下怎麼放含有javadoc的jar檔到Netbeans中

Netbeans即時顯示println的說明

以下以SLF4J為範例說明如何加入javadoc(若讀者沒聽過SLF4J可直接把SLF4J簡單想成println的另一個函式庫)

1. 加入slf4j-api-1.7.7.jar和slf4j-simple-1.7.7.jar到專案中

2. 加入以下用SLF4j寫的簡單程式碼

package test;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Test {
    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(Test.class);
        logger.info("Hello World");
    }
    
}

在寫以上的code過程中就會看到Javadoc not found

3. 加入slf4j-api-1.7.7-javadoc.jar和slf4j-simple-1.7.7-javadoc.jar

  i. 對slf4j-api-1.7.7.jar按右鍵並選擇edit

  ii. 加入slf4j-api-1.7.7-javadoc.jar到Javadoc的欄位中

  

  iii. 同i和ii的步驟將slf4j-simple-1.7.7-javadoc.jar設定為slf4j-simple的javadoc

4. 重新寫一次logger.info會發現Netbeans終於跳出javadoc了！ (WIndows的Netbeans使用者可透過ctrl + shift + space的快捷鍵叫出javadoc，但OS X上我找不到快捷鍵Orz...)

小知識

  在網路上下載的jar檔常常會看到xxx.jar, xxx-sources.jar, xxx-javadoc.jar，這些jar檔代表不同的意思

種類	說明
xxx.jar	已將.class檔案們打包好的檔案，xxx.jar也有可能已經包含source和javadoc(例如Android Volley建置出來的jar就包含了javadoc)
xxx-sources.jar	包含source的jar檔，在debug時可以看到引用的jar檔的source code
xxx-javadoc.jar	包含javadoc的jar檔，使用Netbeans開發時可以即時看到jar內某個class, method, ... etc. 的說明