java - 如何修改 Javadoc 以隐藏特定类

Question

我想获得一个 javadoc，其中包括一个类中所有类的文档。我不希望这个类是私有的 - 然后只在公共类上制作 javadoc - 但想知道是否有一种方法可以在某处设置一个我不想显示的类的名称在 javadoc 中 - 或者我可以在类上放置一个标签，然后 Javadoc 不包含它。

Answer 1

您可以从 javadoc 中排除一个类。但是，如果该类在某处被引用，则该名称将出现在该 javadoc 中。

您甚至在谈论隐藏，那么如果用户看不到正确的签名，那么制作 javadoc 的意义何在？

http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#exclude

Answer 2

这是我发现的符合我的具体情况的答案，在这种情况下，我不需要我想在文档之外保留的类，可以在它们所在的包之外访问。

因此，在这种情况下，您不要将这些类声明为公共类并将它们与使用它们的类放在同一个包中。

例如，如果您有一个需要为其生成 JavaDocs 的类，并且该类称为 CustomUtility 并且声明如下：

public class CustomUtility {

}

但是 CustomUtility 使用了另外两个名为 Calculate 和 Process 的类，它们不应该被项目范围内的任何其他类访问，也不应该包含在您的 JavaDocs 中。您只需确保这两个类与 CustomUtility 在同一个包中，然后像这样声明它们：

class Calculate {

}

和

class Process {

}

然后，当您生成 JavaDocs 时，请确保您的范围设置为 Project production files，并且这两个类不会包含在 JavaDocs 中。

Answer 3

从您的代码中临时删除它，并生成代码然后返回它