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) 
    ...

（没有包名）

我应该在eclipse javadoc Extra javadoc选项中做什么？非常感谢。

Answer 1

我不确定如何在Eclipse中配置它，但标准doclet具有-noqualifier option。

如果您不希望显示任何包名称，可以使用-noqualifier all，如果您只想省略某些包名称，可以列出这些，如下所示：-noqualifier java.lang:java.io。

请注意，在这些情况下，最好还有一个-link或-linkoffline选项链接到这些类的文档，因此读者有机会找出这里的类是什么意思

Answer 2

For those using Maven (and the maven-javadoc-plugin), here is an example of specifying "noqualifier" and "links" for the javadocs plugin (within the project's pom.xml file).

<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>

Documentation on the "noqualifier" parameter is very succinct, and can be found here: https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#noqualifier

Full documentation on the "links" parameter is available here: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html

Answer 3

对于Ant，您还可以在使用Ant的javadoc task通过build.xml定义javadoc输出时从包名称中删除限定符。

noqualifier是<javadoc>的属性，它需要删除“全部”或冒号分隔的限定词列表。这是一个例子，

一个蚂蚁build.xml示例行从java.lang，java.io和java.util中删除了Javadoc限定符，看起来像这样：

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

没有包名的javadoc参数

3 个答案: