如何在Java中将javadoc添加到静态初始化程序？

Question

我重构了一个类，并将一些代码从构造函数移动到静态初始化程序。我应该怎么处理构造函数上的javadoc？是否可以将javadoc添加到静态初始化程序中？

Answer 1

JavaDoc主要用于记录类的接口。 JavaDoc注释必须在类，字段，构造函数或方法声明之前。

静态初始值设定项不是接口的一部分。它是该类实现的一部分。

如果需要，您可以在课程文档中记录其行为。

Answer 2

首先，如果静态初始化器是开始时的好习惯，那是有争议的。

如果您决定使用它们，我会将文档添加到类级别的JavaDoc 。静态初始化程序可以根据它们的实现方式产生副作用。如果您使用带有副作用的静态初始值设定项，则应该为所述类的使用者记录该行为。

Answer 3

我会说该文档的重要部分应该移到类'文档：

/**
 * Your text here.
 */
public class SomeClass {
   static {
      /* your static initalizer */
   }
}

Answer 4

Java中没有静态构造函数（as oposed to C#），这就是为什么你必须在类级别记录这种行为。

此外，由于静态初始化程序很可能初始化一些静态字段，如果这些字段是公共的，受保护的（或包私有的，具体取决于您的JavaDoc可见性约定），那么您需要添加有关这些字段初始化方式的详细信息。基于静态初始化程序的行为。