在編寫一個依賴庫的時候,我們可能需要打成aar包出來,供他人使用,這時候生成說明文檔是很有必要的。至於註釋,這裏就不做說明了。
直接進入主題吧。。。
首先選擇Tools -> Generate JavaDoc
出來下面這個界面
我們可能需要填寫上圖標紅的部分的值, Ouput Directory : 選擇我們將生成的文檔的存放位置。
Other command line arguments: 如果我的註釋有中文,那麼我們需要指定一下字符編碼。
直接點擊 OK,就可以生成說明文檔了到我們指定的位置了。
注意:這時候可能會報錯,通常情況下只會報這個錯:
java.lang.IllegalArgumentException
at sun.net.www.ParseUtil.decode(ParseUtil.java:202)
...
這裏其實是我們的環境 變量配置的問題,在以往我們配置JDK環境變量時,會配置一個CLASSPATH,裏面的值一般都是引用%JAVA_HOME%,我們需要修改這個配置
將CLASSPATH改爲具體的路徑值,如:C:\Program Files\Java\jdk1.7.0_80\jre\lib,當然,這是我電腦安裝JDK的路徑,你需要改你自己電腦JDK的安裝路徑,重啓IDE後生效,如果無效,請重啓電腦。
見官方參考文檔 http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html