javadocのデフォルト値

Question

私はAppConfigクラスのライブラリを持っています。

AppConfigのデフォルト値をこのライブラリを使用して他の開発者に知らせるにはどうすればよいでしょうか？私が持っている

ひとつのアイデアは、javadocのそれを言及するために、このようなものです：

public class AppConfig { 
    private int someSetting = 50; 

    /** 
    * This setting does something. 
    * 
    * @default 50 
    */ 
    public int setSomeSetting(int someSetting){ 
     this.someSetting = someSetting; 
    } 
} 

しかし、このシナリオのための実際のベストプラクティスは何ですか？

Answer 1

正しい（私は@defaultが実際にサポートされたタグではないと信じていたように）。そのような注釈はありません。

そこから：これは「純粋なスタイル」のみです。意味：javadocは大丈夫です - あなたは何でもあなたのために働きます。このクラスを使用するあなたの周りの人々のチームです。しかし

本当にトリッキーな質問：は情報のその部分を入れて！あなたが見る：クラスsetSomeSetting()のユーザー...あなたがすでにに適用されている場合、デフォルト値が適用されます。

つまり、コンストラクタ内でこれらのデフォルトを使用している可能性があります。だから、あなたはむしろそれらのデフォルトについて "class javadoc"のユーザ権限を伝えるべきです。おそらくその価値観。

などは：

/** 
* ... Provides properties x, y,z; with defaults 50, 100, 150 
*/ 
public class Foo { 
    public final int BAR_DEFAULT = 50; 
    private int bar = BAR_DEFAULT; 

    public void setBar(int newBar) { bar = newBar; }