我重构了一个类,并将一些代码从构造函数移到了静态初始化器中。我应该如何处理构造器上的javadoc?可以将javadoc添加到静态初始化器中吗?
发布于 2011-06-23 21:10:28
首先也是最重要的,静态初始化器是不是一开始就是很好的做法,这是有争议的。
如果您仍然决定使用它们,我会在类级别将文档添加到JavaDoc。静态初始化器可能会产生副作用,具体取决于它们的实现方式。如果您使用有副作用的静态初始化器,则应该为所述类的使用者记录该行为。
发布于 2011-06-23 21:08:12
JavaDoc主要用于记录类的接口。JavaDoc注释必须在类、字段、构造函数或方法声明之前。
静态初始化器不是接口的一部分。它是类实现的一部分。
如果需要,您可以在类文档中记录它的行为。
发布于 2011-06-23 21:09:58
我想说的是,文档的重要部分应该移到类的文档中:
/**
 * Your text here.
 */
public class SomeClass {
   static {
      /* your static initalizer */
   }
}https://stackoverflow.com/questions/6454482
复制相似问题