不带包名的javadoc参数

Question

基本上，eclipse导出javadoc输出格式如下：

    Method
    Modifier and type        Method and description
    java.lang.String         getData(java.lang.String key)
    java.lang.String         echo(java.lang.String string) 
    ...

如果我想另一种格式，如：

    Method
    Modifier and type        Method and description
    String                   getData(String key)
    String                   echo(String string) 
    ...

（没有包名称）

在EclipseJavadoc额外javadoc选项项中我应该做什么？非常感谢。

Answer 1

对于Ant，当使用Ant的javadoc任务通过build定义javadoc输出时，还可以从包名中删除限定符。xml。

noqualifier是

从java.lang、java.io和java.util中删除Javadoc限定符的antbuild.xml示例行如下所示：

<javadoc sourcepath="${src.dir}" destdir="${doc.dir}"
         classpathref="compile.classpath" access="public"
         noqualifier="java.lang:java.io:java.util"/>

Answer 2

对于使用Maven（以及Maven javadoc插件）的用户，下面是一个为javadocs插件（在项目的pom.xml文件中）指定“noqualifier”和“links”的示例。

<build>
  <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.3</version>
        <configuration>
          <noqualifier>all</noqualifier>
          <links>
            <link>http://hbase.apache.org/apidocs/</link>
            <link>http://docs.oracle.com/javase/7/docs/api/</link>
          </links>
        </configuration>
        <executions>
          <execution>
            <id>javadocs</id>
            <phase>package</phase>
            <goals>
              <goal>javadoc</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
  </plugins>
</build>

关于“noqualifier”参数的文档非常简洁，可以在这里找到：https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#noqualifier

有关“链接”参数的完整文档可在以下位置获得：https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html

Answer 3

我不确定在Eclipse中是如何配置的，但标准doclet有-noqualifier选项。

如果你不想显示任何包名，你可以使用-no限定符all，如果你只想省略一些包名，你可以列出这些，像这样：-no限定符java.lang：java.io。

请注意，在这些情况下，最好还有一个-link或-linkoffline选项链接到这些类的文档，这样读者就有机会了解这里指的是哪个类。