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調用接口的構造函數

回答

相關問題