java - 公共(public)方法与公共(public) API

Question

在 clean code book 中，有一点写着“公共(public) API 中的 Javadocs”。

和Effective java book一样，有这一项:

“第 56 条:为所有公开的 API 元素编写文档注释”。

所以这是我的问题“是否所有公共(public)方法都被视为公共(public) API？”

Answer 1

它们对我来说是不同的东西。

公共(public) API 是向全世界公布和发布以供使用的 API。因此，预计许多您无法控制的客户会使用它。这也意味着更改更加困难，因为您需要考虑向后兼容性以及诸如此类的事情，如果您想确保任何更改都不会破坏现有客户端。因此，它们应该在 javadocs 中得到很好的记录，以描述实际行为。

Pubic 方法只是声明为 public 的 java 方法。您可以声明一个仅供内部使用的公共(public)方法，在这种情况下它不是公共(public) API。由于它仅在内部使用，您可以完全控制使用它的客户端。更改 API 签名及其行为要容易得多，因为您可以更改这些客户端以适应新的更改。

另见 this article因为 public 和 public 之间的区别实际上比 public 和 private 之间的区别更重要。