java - Javaの静的初期化子にjavadocを追加するにはどうすればよいですか？

Question

クラスをリファクタリングし、一部のコードをコンストラクターから静的初期化子に移動しました。コンストラクターにあったjavadocをどうすればよいですか？静的初期化子にjavadocを追加することは可能ですか？

Answer 1

JavaDocは、主にクラスのインターフェースを文書化することを目的としています。JavaDocコメントは、クラス、フィールド、コンストラクタ、またはメソッド宣言の前に置く必要があります。

静的初期化子はインターフェースの一部ではありません。これは、クラスの実装の一部です。

必要に応じて、その動作をクラスのドキュメントに文書化できます。

Answer 2

何よりもまず、静的初期化子が最初から良い習慣であるかどうかは議論の余地があります。

それでも使用することにした場合は、クラスレベルでJavaDocにドキュメントを追加します。静的初期化子は、実装方法によっては、副作用を引き起こす可能性があります。副作用のある静的初期化子を使用する場合は、そのクラスのコンシューマーの動作を文書化する必要があります。

Answer 3

Javaには静的コンストラクター（C＃とは対照的）のようなものはありません。そのため、この動作をクラスレベルで文書化する必要があります。

また、静的初期化子は一部の静的フィールドを初期化する可能性が高いため、これらのフィールドがpublic、protected（、またはJavaDocの可視性規則に応じてpackage-private）の場合、これらのフィールドが初期化される方法に関する詳細を追加します。静的初期化子の動作。

Answer 4

そのドキュメントの重要な部分をクラスのドキュメントに移動する必要があると思います。

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