java - 为什么使用 javadoc 无参数构造函数？

Question

在 Effective Java(第三版)的第 56 条中，Joshua Bloch 指出:“公共(public)类不应使用默认构造函数，因为无法为它们提供文档注释。”

默认构造函数不会做任何意外的事情，不过，它只是创建一个新实例。什么样的信息应该记录在无参数构造函数的文档注释中，而不应该只存在于类注释中？

如果一个类在初始化 block 中有有趣的行为(否则没有地方可以注释这些)，或者甚至是非标准的字段赋值(可能调用方法来获取初始值)，我可以理解这样做。但对于大多数类(class)来说，这似乎并没有增加太多。有什么我想念的吗？

Answer 1

在大多数情况下你是对的。
而且我认为在这些情况下，使用默认构造函数是有意义的，因为您无需记录任何内容。

现在在其他一些情况下，记录方法的作用以及更具体的默认状态非常有用。

因为即使默认构造函数的主体为空，它也可能在其字段中使用默认值，这可能对记录很有趣。

这里有两个 JDK 类的例子，其中 javadoc 可能会为具有空主体的构造函数带来有用的信息。

堆栈

/**
 * Creates an empty Stack.
 */
public Stack() {
}

当然，客户可能会在调用此构造函数时猜测 Stack 为空，但明确指定它会更好。

原子整数

采用AtomicInteger 空构造函数:

/**
 * Creates a new AtomicInteger with initial value {@code 0}.
 */
public AtomicInteger() {
}

AtomicInteger 构造函数被重载。所以我们不在潜在的默认构造函数案例中。
但无论如何，它是一个空主体的空参数构造函数，类似于默认构造函数产生的结果。

如果没有这些构造函数 javadoc，这些类的客户端应该查看实现以猜测信息，并且限制客户端查看实现以理解其规范的 API 不是一个设计良好的 API。