JavaDoc:仅记录用户应该使用的框架中的公共方法?

时间:2015-05-31 23:47:51

标签: java javadoc maven-javadoc-plugin

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

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

我希望JavaDoc只发布用户应该调用的那些方法的文档,而不是其他方法。因此,在示例中,它应该记录工厂方法,而不是公共构造函数。

当然,JavaDoc本身不知道哪个是哪个,所以我认为“公共”方法可以用一些Annotation注释,比如@SupportedAPI,而JavaDoc只会吐出那些文档。 (这将有额外的好处,可以清楚地标记哪些方法可以保持稳定。)

可以配置JavaDoc吗?

1 个答案:

答案 0 :(得分:0)

我也很想念这个。我有一个Java库,该库分为多个包。其中的某些方法仅是因为它们需要由该库的其他程序包使用,而不必由该库的用户使用,因此是公共的。

我一直在与yDoc(Javadoc的doclet扩展)并驾齐驱,它为类和方法添加了 @ y.exclude 标记,以防止它们被记录下来。这远非完美的解决方案,但仍优于默认的Javadoc。

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