为什么不通过ant的javadoc显示我方法的一些文档?

时间:2016-12-30 20:51:29

标签: java ant javadoc

我正在尝试通过ant为一个小型测试项目生成一些javadoc,但我并不真正理解它的所有行为。似乎我的主要课程中的很多方法都被遗漏了,我并没有真正理解为什么。

以下是一个例子:

/**
 * Diese Methode deligiert die Ausfuehrung der zustandsabhaengigen Aktion an die entsprechende Methode
 * des Zustandsobjektes weiter, welches gerade in der Objektvariable zustand gespeichert ist.
 * @see SetMinutes
 * @see SetHours
 * @see DisplayTime
 */
 void inc(){
    zustand = zustand.inc(this);
 }

这个没有显示。我的蚂蚁目标如下:

<target name="doc" depends="generateJar">
    <javadoc destdir="${doc.dir}">
            <fileset dir="."/>
    </javadoc>
</target>

显示的唯一方法是main方法(记录在案)和run()方法(空)。让我想知道的是,我的项目其他类中的方法文档是正确生成的,我看不出区别。 (我也有生成字段摘要的问题,但这可能是另一个问题的问题,不是吗?)

任何帮助都将不胜感激。

2 个答案:

答案 0 :(得分:3)

默认javadoc命令行选项为-protected,仅生成publicprotected方法。

要获取包私有方法(inc()为),您必须指定-package-private

Oracle文档:http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDCIFFD

答案 1 :(得分:0)

编辑:为了适应Stefan Bodewigs的评论。

有了Jim Garrison的暗示,我能够找到解决方案,如下所示(我还将总结已经说过的所有内容都在一个帖子中):

  • javadoc的默认命令行选项是-protected,它不会为私有和包私有字段和方法生成javadoc
  • 如果有人希望通过蚂蚁自动化我们可以使用 包=&#34;真&#34; (或私人=&#34;真&#34;如果希望也包括这些领域和方法)

示例:

<target name="doc" depends="generateJar"> <!--default option für javadoc ist -protected (siehe Web) daher fliegen im default package private methoden raus aus der doc-->
    <javadoc destdir="${doc.dir}" package="true">
            <fileset dir="."/>
    </javadoc>
</target>