Javadoc调用接口的构造函数

我有一个名为PlayerDatabase的接口和一个名为DatabaseUI的类。我有问题写javadoc，我真的不知道如何定义我在做什么。Javadoc调用接口的构造函数

public class DatabaseUI { 
     private final PlayerDatabase database; 
     /** 
     * This constructor calls on the database so that the 
     * UI can work with it. 
     * 
     * @param database contains {@code Player}'s 
     */ 
     public DatabaseUI(PlayerDatabase database) { 
      this.database = database; 
     } 
    }

这是很好的javadoc，这是我究竟在做什么？

来源

2014-10-30 Baaananz

[编辑]删除了愚蠢。 – FelixMarcus 2014-10-30 12:14:07

@FelixMarcus你错过了一些相当基本的东西......你可以通过实现接口的类传递对象 – user2717954 2014-10-30 12:17:00

是的，我似乎有一个休息日。没关系。 – FelixMarcus 2014-10-30 12:18:05

编写java文档时，你不会解释你的代码如何工作，这是什么意见。 Java文档用于使用您的代码的人，而不知道或关心您是如何实现它的。你需要解释如何使用构造函数而不是它如何工作。即你说什么是预期的论点和其他用户应该知道的构造函数将创建的对象

来源

2014-10-30 12:19:13 user2717954

private final PlayerDatabase数据库; /** *调用数据库，以便UI可以使用它。 * * @参数数据库包含{@code Player}的 */ public DatabaseUI（PlayerDatabase数据库）{ this.database = database; } 也许这样，我仍然是新的Java和编程，并发现javadoc真的很难。现在我很困惑，我真的在调用数据库还是创建实例或副本？ – Baaananz 2014-10-30 12:29:07

Javadoc调用接口的构造函数

回答

相关问题