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

Question

给出以下代码段:

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

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

所以,一方面,我们不想在Javadoc注释中写入冗余信息,另一方面,必须有一个Javadoc注释(有吗？).

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

Answer 1

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