我正在尝试通过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>
唯一显示的方法是主要方法(已记录为记录)和run()方法(空)。我也想知道的是,我对项目其他类别中方法的文档得到了正确生成,我看不到差异。(我也有生成字段摘要的问题,但这可能是另一个问题的东西,不是吗?)
任何帮助将不胜感激。
默认javadoc
命令行选项是-protected
,它仅生成public
和protected
方法。
要获取软件包私有方法(如inc()
,您必须指定-package
或-private
。
oracle文档:http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#chdciffd
编辑:要适合Stefan Bodewigs评论。
带有吉姆·驻军的提示,我能够找出如下的解决方案(我还将总结一篇文章中已经说过的所有内容):
- javadoc的默认命令行选项是受保护的
- 如果希望通过蚂蚁自动化这一点,我们可以使用package =" true"(或私有=" true",如果也希望包括这些字段和方法)
示例:
<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>
更改包含JavaCode的文件夹。编译代码。然后运行以下命令。
javadoc -private -splitindex <(compiledclassfilename)>.java