ttt*_*ppp 7 java javadoc static-initializer
我重构了一个类,并将一些代码从构造函数移动到静态初始化程序.我应该怎么处理构造函数上的javadoc？是否可以将javadoc添加到静态初始化程序？
JavaDoc主要用于记录类的接口.JavaDoc注释必须在类,字段,构造函数或方法声明之前.
静态初始化程序不是接口的一部分.它是该类实现的一部分.
如果需要,您可以在类文档中记录其行为.
首先,如果静态初始化器是良好的实践,那么它是有争议的.
如果您决定使用它们,我会在类级别将文档添加到JavaDoc.静态初始化程序可以根据它们的实现方式产生副作用.如果您使用带有副作用的静态初始值设定项,则应该为所述类的使用者记录该行为.
| 归档时间： |
|
| 查看次数： |
1373 次 |
| 最近记录： |