文章目錄

• 1. JavaDoc的配置
• 2. JavaDoc的輸出
• 3. 常見問題
• 4. 使用gradle指令碼

1. JavaDoc的配置

2. JavaDoc的輸出

Tools → Generate JavaDoc…

3. 常見問題

錯誤: 編碼GBK的不可對映字元
這是在utf-8專案中常會遇到的問題，其實也就是字元編碼問題。
我們可以在VM的setting中進行如下設定：-encoding utf-8 -charset utf-8

4. 使用gradle指令碼

在目標project裡面建立一個task：

task javadocJar(type: Javadoc) {
    source = project.android.sourceSets.main.java.srcDirs
    options.linkSource true
    classpath += project.files(project.android.getBootClasspath().join(File.pathSeparator))
    failOnError false
}

然後在gradle的tab裡，找到這個工程中的javadocJar指令碼，雙擊執行。

這樣在專案的build目錄下會自動建立javadoc檔案：