Javadoc沒有爲繼承方法生成評論

我正在使用Ant來創建我的文檔。我使用{@inheritDoc}的方法，如equals,hashCode和toString。但是，這些方法沒有說明。見截圖：Javadoc沒有爲繼承方法生成評論

enter image description here

這裏是我的Ant腳本：

<project name="javadoc" default="javadoc.tool"> 
    <description> 
    Provides JavaDoc. 
    </description> 

    <import file="build.xml" /> 
    <property name="javadoc.dir" location="${build.dir}/javadoc" /> 
    <property name="javadoc.failonerror" value="false" /> 

    <target name="javadoc.tool" depends="compile" description="Generate JavaDoc."> 
    <mkdir dir="${javadoc.dir}" /> 
    <javadoc classpathref="compile.classpath" 
      sourcepath="${src.dir}" 
      destdir="${javadoc.dir}" 
      author="true" 
      version="true" 
      use="true" 
      package="true" 
      overview="${src.dir}/overview.html" 
      windowtitle="${system.name} API" 
      doctitle="${system.name} API" 
      failonerror="${javadoc.failonerror}" 
      excludepackagenames="junit" 
      linksource="true" /> 
    </target> 
</project>

我怎樣才能得到繼承方法的描述文檔中展現出來？您的建議將不勝感激。謝謝！

來源

2012-09-08 BJ Peter DeLaCruz

如果您嘗試從標準Java類繼承文檔，那麼您需要在源路徑中包含JDK src.zip。 （您可能需要解壓縮;我不記得）

這就是說，如果您的方法對某些「意想不到的事情」，您應該編寫自己的文檔。如果他們不這樣做，你不需要需要他們的描述。

來源

2012-09-08 21:29:27

使用Oracle JDK 1.7，將'src.zip'指定爲'sourcepath' 由於錯誤而失敗。解壓縮src.zip工作，儘管有2705個警告。 –

@cpeisert可能會有關於內部類的警告;還沒有嘗試過。 –

我知道這是一箇舊線程，但通過javadoc Ant任務鏈接到外部API的正確方法是使用嵌套<link>元素。例如，要鏈接到Java 7的API：

<javadoc ... > 
    ... 
    <link href="http://docs.oracle.com/javase/7/docs/api/" /> 
</javadoc>

請對所有細節閱讀related Ant documentation。

來源

2014-05-07 20:37:52 Lolo

Javadoc沒有爲繼承方法生成評論

回答

相關問題