Javadoc对简单构造函数的注释。需要还是不必要？

Question

给出以下代码片段：

/**
 * Initializes a new instance.
 *
 */
public Collector() {
    this.map = new HashMap<>();
}

请专注于 Javadoc评论：这个构造函数中没有发生太多事情。那么，为什么编写Javadoc的正确方法呢？如上所示？这将是完全准确但同时多余，因为构造函数意味着初始化一个新实例。

所以，一方面，我们不想在Javadoc注释中写入冗余信息，另一方面，必须有一个Javadoc注释（有吗？）。

那么，简而言之，如何在这种情况下编写有意义的，而不是多余的 Javadoc？

Answer 1

这取决于谁是代码的读者以及构造函数的功能是多么明显。 javadoc是读者（闭源）的唯一信息来源，或者读者可以从源头轻松掌握详细信息。在我们的项目中，我们根本没有javadoc明显的功能。当一些形式主义需要javadoc时，我们只需使用/ ** Constructor。 * /只是满足形式主义。