java - クラスのプライベート変数を介したJavaドキュメントストリング

Question

public static class cls{
    private String text;
    public String getText(){
        return text;
    }
}

コンテンツをコピーペーストすることなく、Javatextの docstrings に変数を表示することは可能ですか?cls

Answer 1

あなたが何をしようとしているのかわからない。次の 2 つの方法のいずれかを使用して、JavaDoc から変数にリンクできます。

/**
 * The cls class
 * see {@link cls#text} or
 * @see cls#text
 */
public static class cls {
    private String text;
...

次に、JavaDoc をこの変数に添付して、そこに何を言う必要があるかを記述できます。私の知る限り、コピーして貼り付ける以外に、JavaDoc 内にコード行を表示する方法はありません。ただし、必要に応じて、HTML を使用して書式設定を改善できます。

/**
 * The cls class, see this field:
 * <code>private String text;</code>
 */
public static class cls {
    private String text;
...

それが役に立てば幸いですが、疑問が残ります:パブリックゲッターがある場合、なぜ実装を公開したいのですか?