如何爲EJB和它們的接口編寫Javadoc？

考慮下面的例子如何爲EJB和它們的接口編寫Javadoc？

@Remote 
public interface RegistrationService { 
    public String register(); 
    public void unregister(String id); 
    public void heartbeat(String id); 
} 

@Stateless 
@Remote(RegistrationService.class) 
public class RegistrationServiceBean implements RegistrationService { 
    /* ... */ 
}

我有一個接口，可以說RegistrationService。藉此，遠程客戶端可以將自己註冊到應用程序中。通過週期性地呼叫心跳（），它表示它仍然活着。

什麼是正確的方式來記錄EJB及其接口？

例如：

接口

該接口的用戶可以將其自身註冊到該應用程序。然後，應用程序重新計算一些東西，在所有註冊的客戶端上均勻分配。 （這將涉及對其他類，例如重新計算類知識）
接口的用戶可以註冊自己並通知服務器，如果它是仍然連接。實現使用該信息發佈任務的基礎上註冊客戶量底層系統（這並不涉及對其他類的知識，然而，這不是從應用的角度來看這樣precice）

類

當客戶端註冊，取消註冊或心跳過期時，RegistrationService的此實現會在RecalculationClass中發出重新計算。這是必要的，因爲數據必須在客戶端之間均勻分佈。

任何想法讚賞。謝謝。

斯文

來源

2012-10-23 Sven Plath

接口的javadoc應該沒有任何關於執行情況的信息。接口大約是什麼，而不是如何。

例如，實現完全忽略對接口方法的調用是有效的 - 即有一個空方法。

你的javadoc應該這樣說：Notifies that the specified application is still alive。什麼實施選擇做與信息是由它決定的。

來源

2012-10-23 06:34:54 Bohemian

我想說這取決於哪些信息對客戶很重要。如果重新計算完全針對用戶，則可能不需要在界面中記錄它。如果客戶以其他方式看到重新計算細節，則必須在此處指出，以便用戶知道可能發生哪些交互。如果重新計算完全是內部的，並且可以在客戶沒有注意到的情況下進行更改，則它不需要也不應該在界面描述中。

來源

2012-10-23 06:38:00 koljaTM

如何爲EJB和它們的接口編寫Javadoc？

回答

相關問題