使用eclipse生成文档（javadoc）及碰到问题解决

使用eclipse生成文档（javadoc）及碰到问题解决

　　使用eclipse生成文档（javadoc）主要有四种方法：
　　1，在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。
　　在Javadoc Generation对话框中有两个地方要注意的：
　　javadoc command:应该选择jdk的bin/javadoc.exe
　　destination:为生成文档的保存路径，可自由选择。
　　按finish(完成)提交即可开始生成文档。
　　2，用菜单选择：File->Export(文件－>导出)，
　　剩下的步骤和第一种方法是一样的。
　　3，选中要生成文档的项目，然后用菜单选择，
　　Project->Generate Javadoc直接进入Javadoc Generation对话框，剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。
　　
　　完善api-doc，用eclipse生成javadoc的时候发生“编码 GBK 的不可映射字符 ”其实是字符编码问题。
　　打开eclipse，project -> Generate javadoc 一项一项的选你要输出javadoc的项目，最后一步中VM设置行中加入以下代码
　　Java代码
　　-encoding utf-8 -charset utf-8
　　
　　四　maven 打包时另上　

<plugin>         
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.7</version>
    <executions>
      <execution>
        <id>attach-javadocs</id>
          <goals>
            <goal>jar</goal>
          </goals>
      </execution>
    </executions>
  </plugin>   

运行maven install    然后再运行到target/apidoc下运行javadoc.bat

　
　　javadoc生成文档时总是报java.lang.IllegalArgumentException错误,是classpath里面字符冲突引起的。我在classpath中包含了%JAVA_HOME%\lib;解决方法是重新设置classpath或者删除classpath.要注意设置完成后重启下cmd或者editplus，重启后生效！
　　
　　见官方参考文档 http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html
　　
　　You are on Windows XP with Sun JDK 5 or JDK 6 freshly installed, and when you run mvn javadoc:javadoc, you are stick by an sun.net.www.ParseUtil.decode() exception like this one.
　　
　　...
　　[INFO] ------------------------------------------------------------------------
　　[ERROR] BUILD ERROR
　　[INFO] ------------------------------------------------------------------------
　　[INFO] An error has occurred in JavaDocs report generation:Exit code: 1 - java.lang.IllegalArgumentException
　　 at sun.net.www.ParseUtil.decode(ParseUtil.java:189)
　　 at sun.misc.URLClassPath$FileLoader.(URLClassPath.java:953)
　　 at sun.misc.URLClassPath$3.run(URLClassPath.java:326)
　　 at java.security.AccessController.doPrivileged(Native Method)
　　 at sun.misc.URLClassPath.getLoader(URLClassPath.java:320)
　　 at sun.misc.URLClassPath.getLoader(URLClassPath.java:297)
　　 at sun.misc.URLClassPath.findResource(URLClassPath.java:144)
　　 at java.net.URLClassLoader$2.run(URLClassLoader.java:362)
　　 at java.security.AccessController.doPrivileged(Native Method)
　　 at java.net.URLClassLoader.findResource(URLClassLoader.java:359)
　　 at java.lang.ClassLoader.getResource(ClassLoader.java:977)
　　 at java.lang.ClassLoader.getResourceAsStream(ClassLoader.java:1159)
　　 at javax.xml.parsers.SecuritySupport$4.run(SecuritySupport.java:96)
　　 at java.security.AccessController.doPrivileged(Native Method)
　　 at javax.xml.parsers.SecuritySupport.getResourceAsStream(SecuritySupport.java:89)
　　 at javax.xml.parsers.FactoryFinder.findJarServiceProvider(FactoryFinder.java:250)
　　 at javax.xml.parsers.FactoryFinder.find(FactoryFinder.java:223)
　　 at javax.xml.parsers.SAXParserFactory.newInstance(SAXParserFactory.java:128)
　　
　　 Command line was:C:\Java\jdk1.6.0_03\jre\..\bin\javadoc.exe @options @packages
　　 ...
　　
　　Your CLASSPATH environement variable is probably corrupted, i.e. something like:
　　
　　CLASSPATH=.;C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip;%JAVAHOME%
　　
　　with %JAVAHOME% not a valid environment variable.
　　
　　To resolve it, just reset the CLASSPATH environement variable, i.e.:
　　
　　set CLASSPATH=
　　
　　or set a new CLASSPATH environement variable, i.e.:
　　
　　set CLASSPATH=C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip
　　
　　or fix the wrong environment variable.