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; }