javadoc相關問題

歡迎和大家交流技術相關問題： 郵箱: [email protected] 博客園地址: http://www.cnblogs.com/jiangxinnju GitHub地址: https://github.com/jiangxincode 知乎地址: https://www.zhihu.com/people/jiangxinnju

• src源代碼生成html格式文檔：http://www.cnblogs.com/shenliang123/archive/2012/04/23/2466483.html
• 自己動手製作chm格式開源文檔：http://www.cnblogs.com/shenliang123/archive/2012/04/23/2466441.html
• Javadoc轉換chm幫助文檔的四種方法總結: http://lishunli.iteye.com/blog/1051688
• 如何使用eclipse生成javadoc幫助文檔？:http://jingyan.baidu.com/article/dca1fa6f4d3d7ff1a4405239.html

maven下載源碼和javadoc

當在IDE中使用Maven時如果想要看引用的jar包中類的源碼和javadoc需要通過maven命令下載這些源碼，然後再進行引入，通過mvn命令能夠容易的達到這個目的：

    mvn dependency:sources
    mvn dependency:resolve -Dclassifier=javadoc

命令使用方法：首先進入到相應的pom.xml目錄中，然後執行以上命令。第一個命令嘗試下載在pom.xml中依賴的文件的源代碼。第二個命令嘗試下載對應的javadocs。但是有可能一些文件沒有源代碼或者javadocs。也可以通過配置文件添加，打開maven配置文件 setting.xml文件(.../.m2/settings.xml) 增加如下配置：

    <profiles>
    <profile>
        <id>downloadSources</id>
        <properties>
            <downloadSources>true</downloadSources>
            <downloadJavadocs>true</downloadJavadocs>
        </properties>
    </profile>
    </profiles>

    <activeProfiles>
      <activeProfile>downloadSources</activeProfile>
    </activeProfiles>

配置eclipse

Window > Preferences > Maven and checking the "Download Artifact Sources" and "Download Artifact JavaDoc" options

maven中如何生成javadoc

mvn javadoc:javadoc

javadoc注意點（原創）

javadoc生成文檔時總是報java.lang.IllegalArgumentException錯

JavamavenEXTSUNJDK .

javadoc生成文檔時總是報java.lang.IllegalArgumentException錯誤,是classpath裏面字符衝突引起的。我在classpath中包含了變量引用，如：%JAVA_HOME%\lib;解決方法是重新設置classpath或者刪除classpath.要注意設置完成後重啓下cmd或者editplus，重啓後生效！

見官方參考文檔 http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html

javadoc生成時出錯：編碼GBK的不可映射字符

由於java源代碼是用的UTF-8編碼，Eclipse中默認編碼是GB18030，因此，在生成javadoc的時候，需要手工指定一下編碼和字符集。

解決方案是：主菜單–>Project–>Generate javadoc–>next>next–> 在 Extra javadoc options下面的文本框中填入：

-encoding UTF-8 -charset UTF-8

一個例子

javadoc -d doc -subpackages edu.jiangxin -encoding utf-8 -charset utf-8 -exclude edu.jiangxin.utils:edu.jiangxin.service:edu.jiangxin.service.impl