匿名對象方法的Javadoc

適當和有用地記錄匿名對象函數的最佳方法是什麼？我做一些編程與斯奧（API here），並有一些代碼看起來是這樣的：匿名對象方法的Javadoc

/** 
* 
* @return handler that does blah 
*/ 
public static RhsFunctionInterface functionBlah() { 
    return new Kernel.RhsFunctionInterface() { 
     /** 
     * Does blah 
     */ 
     @Override 
     public String rhsFunctionHandler(int eventID, Object data, 
       String agentName, String functionName, String arguments) { 
      return null; 
     } 
    }; 
}

當重要的是要知道什麼是返回對象的功能呢，它預計，參數等。，我不知道該寫什麼。 Eclipse似乎忽略了javadoc的方法，我真的不想爲每個處理程序編寫單獨的類，僅用於文檔目的。

來源

2012-01-10 Nate Glenn

你的交流對象是誰？如果是外部人員，那麼該方法不需要任何文檔，如http://stackoverflow.com/a/8797414/348975所解釋的那樣。如果是內部人員，那麼他們可以直接閱讀源代碼。 – emory 2012-01-10 01:24:30

該方法根本不需要任何文檔，因爲它是接口的實現，並且應該記錄該接口。接口的實現依照那個行爲。

來源

2012-01-10 01:13:23 fivedigit

這個特定的接口用於通用處理程序;處理程序可以執行程序員想要的任何操作。 – 2012-01-10 01:25:36

@NateGlenn在這種情況下，JavaDoc註釋的最佳位置將在functionBlah方法中。此方法的用戶不需要知道或關心您是否使用匿名類實現了該方法。 – emory 2012-01-10 01:34:17

+1 - 如果類需要javadoc註釋，它不應該是一個匿名類。 – 2012-01-10 02:13:34

匿名對象方法的Javadoc

回答

相關問題