我创建了 java api - 从 C# 移植到更具体的 - 除了公共接口之外,它还包含许多我不希望用户知道的内部内容。在 C# 中,我使用 doxygen 来生成文档。我认为 javadoc 具有类似的功能来排除某些公共成员、类,甚至包。
有人会建议如何做到这一点,也许是通过日食?
谢谢
我相信在 Eclipse 中,您可以指定的唯一排除类型是“排除所有受保护的成员”和基于包的排除(而不是基于类的排除)。
如果您使用 Ant 生成它们,则可以使用嵌套的“package”元素,并且可以使用文件集嵌套元素并向该文件集添加排除项。
例如:
<javadoc >
<sourcefiles>
<fileset dir="${src}">
<include name="**/*.java"/>
<exclude name="**/ClassToExclude.java"/>
</fileset>
</sourcefiles>
<packageset>
<dirset dir="${src}">
<include name="com.mydomain.*"/>
<exclude name="com.mydomain.excludePackage"/>
</dirset>
</packageset>
</javadoc>
PS - 我已经使用了<sourcefiles>
很多元素,但从来没有使用过<packageset>
元素。后者在句法上可能并不准确。
当然,当你“生成Javadoc”时,你可以选择这个过程涉及的包并排除其他包
替代文字 http://www.filigris.com/products/docflex_javadoc/images/eclipse_javadoc_1.png
(这里的图是用另外一个工具生成的javadoc,但这并没有改变大意)
您可以在 Java 中使用 doxygen。我不知道有任何工具可以用 Javadoc 做你想做的事。
Superpackages 应该出现在 JDK 7 中,我相信可以解决这个问题:http: //blogs.oracle.com/andreas/entry/superpackages_in_jsr_294