java - 如何阻止 javadoc 为父类(super class)生成文档？

Question

上下文:NetBeans 8.0.2、Java 8.0.0

我已经编写了几个类来封装对话框，以帮助我的学生编写简单、可视化的应用程序，而无需复杂的 GUI 编程知识 - 例如 Tic-Tac-Toe。不幸的是，我让一些类扩展了 JFrame，现在我的 javadoc 中充斥着从类层次结构继承的一长串功能，这让它看起来有点吓人。

我知道我可以重新制定我的实现策略以“使用”JFrame 而不是“成为”JFrame，但是是否有一些更简单的方法告诉 javadoc 不要基于类层次结构生成文档？

谢谢。

编辑:

我使用的是开箱即​​用的 NetBeans 生成器，具有以下附加选项:

-stylesheetfile C:\Users\jack\Documents\NetBeansProjects\CartesianPlane/src/customStylesheet.css -overview "C:\Users\jack\Documents\NetBeansProjects\CartesianPlane/src/Overview.html" -subpackages edu.pcwe.uw.javaintro.cartesian_plane -exclude edu.pcwe.uw.javaintro.cartesian_plane.test

Answer 1

这个问题已经在 J​​avadoc FAQ 中列出了

A16. How can I exclude or skip certain public members or classes from being documented?

[...] There is currently no Javadoc option to hide, exclude or suppress public members from the javadoc-generated documentation.

由于它是自动生成的，并且您没有选择排除的选项，因此您必须处理它。

有an issue scheduled for version 9请求 exclude 标记的地方。

您可能想阅读整个请求，因为它提供了一些排除的解决方法，但我不确定它是否适合您的情况。

编辑:

yDoc (现在根据您的评论重命名为 yWorks)我链接的请求中提到的 doclet 提供了使用 y.exclude 进行一些排除的可能性。

请注意，您必须在父类(super class)上指定 y.exclude。由于 JFrame 是标准 JDK 的一部分，您将无法指定它。除非你想重新编译它，否则肯定会，但很高兴知道你有一个解决方法来为你自己的类做这件事。