生成 javadoc 本身算是比較沒什么難度的事情，android studio 先天就是支持的，但是實際的開發中，我們需要編譯的程序中自動生成，這個就有點撓頭了，如果時 android 的還好，假如是 java 的 library 呢，好吧，頭發就要掉完了
依賴 gradle 生成 android 的 javadoc
task javaDoc(type: Javadoc) {
delete("javadoc/") #清理舊的 javadoc
options{
encoding('UTF-8') #支持中文，避免亂碼
charSet('UTF-8') #支持中文，避免亂碼
memberLevel = JavadocMemberLevel.PUBLIC #保留 public 的方法
linkSource true
author false #是否保留作者
noTree true #是否生成樹狀結構
noIndex true
noNavBar true
}
source = android.sourceSets.main.java.srcDirs #生成 javadoc 的源目錄
#模塊下的第三方庫的類名也能被索引{@link}，應對 javadoc 提示“錯誤：找不到符號”
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
destinationDir = file("javadoc/") #生成 javadoc 的目標目錄
failOnError false #報錯不中斷
}
afterEvaluate {
javaDoc.classpath += files(android.libraryVariants.collect { variant ->
variant.javaCompileProvider.get().classpath.files
})
}
最后在終端執行 javaDoc 即可
gradlew :模塊名:javaDoc
依賴 gradle 生成 java 的 javadoc
task javaDoc(type: Javadoc) {
delete("javadoc/") #清理舊的 javadoc
options{
encoding('UTF-8') #支持中文，避免亂碼
charSet('UTF-8') #支持中文，避免亂碼
memberLevel = JavadocMemberLevel.PUBLIC #保留 public 的方法
linkSource true
author false #是否保留作者
noTree true #是否生成樹狀結構
noIndex true
noNavBar true
}
source = sourceSets.main.allJava #生成 javadoc 的源目錄
#模塊下的第三方庫的類名也能被索引{@link}，應對 javadoc 提示“錯誤：找不到符號”
classpath += configurations.compile
classpath += files({ project(':你的模塊名').sourceSets.main.compileClasspath })
destinationDir = file("javadoc/") #生成 javadoc 的目標目錄
failOnError false #報錯不中斷
}
最后在終端執行 javaDoc 即可
gradlew :模塊名:javaDoc
轉載請註明出處，本文鏈接：https://www.uj5u.com/yidong/291065.html
標籤：其他
上一篇：APP穩定性測驗