1

由于框架的需要，框架通常需要包含具有公共方法的类；使用该框架的用户实际上不应该调用它们。

例如，一个类可能有一个公共构造函数，因此另一个包中的工厂可以实例化它，但用户总是应该使用工厂，而不是直接使用构造函数。

我希望 JavaDoc 只发出关于用户应该调用的那些方法的文档，而不是其他方法。所以在这个例子中，它应该记录工厂方法，而不是公共构造函数。

当然，JavaDoc 本身不知道哪个是哪个，所以我在想“公共”方法可以用一些注解来注解，比如@SupportedAPI，而 JavaDoc 只会吐出关于这些的文档。（这将有一个额外的好处，可以清楚地标记哪些方法有望保持稳定。）

可以配置 JavaDoc 来做到这一点吗？

4

1 回答 1

0

我也很想念这个。我有一个分成包的 Java 库；其中的一些方法是公开的，只是因为它们需要被库的其他包使用，但从不被库的用户使用。

我一直在使用 yDoc（Javadoc 的 doclet 扩展）一瘸一拐地向类和方法添加一个@y.exclude标记，以防止它们被记录在案。这远不是一个完美的解决方案，但仍然比默认的 Javadoc 更好。

看起来 yDoc 已重命名为 yWorks。似乎还有免费的社区版：https ://www.yworks.com/products/ydoc

于 2020-03-02T12:19:48.830 回答