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

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

（因为我相信@default这并不是真正受支持的标签）

Answer 1

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

从那里：这只是“纯粹的风格”；含义：javadoc 很好 - 你可以做任何对你有用的事情；分别是您周围将使用此类的团队。

但真正棘手的问题是：将该信息放在哪里？！您会看到：当该类的用户setSomeSetting()...您已经应用了该默认值。

换句话说：您可能在构造函数中使用这些默认值。因此，您应该在“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; }