java - 如何为 EJB 及其接口(interface)编写 Javadoc？

Question

考虑以下示例

@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 {
    /* ... */
}

我有一个接口(interface)，比如说RegistrationService。这样，远程客户端就可以将自己注册到应用程序上。通过定期调用 heartbeat()，它发出信号表明它仍然活着。

记录 EJB 及其接口(interface)的正确方法是什么？

例如:

界面

1. 此界面的用户可以将自己注册到应用程序上。 然后应用程序重新计算一些东西以均匀分布 所有注册客户。 (这将涉及有关 其他类，例如重算类)
2. 接口(interface)的用户可以自行注册并通知服务器(如果注册) 仍然连接。实现使用此信息来发出 根据注册数量分配给底层系统的任务 客户(这不涉及其他类的知识， 但从应用的角度来看并不那么精确)

类别

1. 当客户端注册、取消注册或检测信号过期时，RegistrationService 的此实现会在 RecalculationClass 中发出重新计算。这是必要的，因为数据必须在客户端之间均匀分布。

任何想法表示赞赏。谢谢。

斯文

Answer 1

接口(interface) javadoc 不应包含有关实现的信息。界面是关于什么，而不是如何。

例如，实现完全忽略对接口(interface)方法的调用是有效的 - 即有一个空方法。

您的 javadoc 应显示如下内容:通知指定的应用程序仍处于 Activity 状态。实现选择如何处理这些信息取决于它。