java - javadoc 的默认值

Question

我有一个带有 AppConfig 的图书馆类(class)。

通知其他使用此库的开发人员的最佳方式是什么 AppConfig 中的默认值是什么？是？

我的一个想法是在 javadoc 中提及它，如下所示:

public class AppConfig {
   private int someSetting = 50;

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

但这种情况下的实际最佳实践是什么？

(因为我相信 @default 并不是真正受支持的标签)

Answer 1

正确的;没有这样的注释。

从那里开始:这只是“纯粹的风格”；意思是:javadoc 很好——你做任何对你有用的事情；分别是您周围将使用该类(class)的团队。

真正棘手的问题是:哪里放那条信息？!你看:当一个类的用户 setSomeSetting() ... 你已经应用该默认值。

换句话说:您可能在构造函数中使用了这些默认值。所以你应该在“class javadoc”中告诉用户这些默认值；可能还有他们的值(value)观。

喜欢:

/**
 * ... 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; }