匿名对象方法的Javadoc

标签 java methods javadoc anonymous-class

正确有效地记录匿名对象功能的最佳方式是什么?我正在使用 Soar (API here) 进行一些编程,并且代码看起来像这样:

/**
 * 
 * @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 的方法,我真的不想仅仅为了文档目的为每个处理程序编写单独的类。

最佳答案

该方法根本不需要任何文档,因为它是接口(interface)的实现,应该记录该接口(interface)。接口(interface)的实现根据该行为。

关于匿名对象方法的Javadoc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8797397/

相关文章:

java - Hibernate 5 ID AUTO Generation Type for Oracle 作为 Sequence 和 MySQL 作为 Identity

java - 使用 Modulo 和 Double 来查找数字的数字有什么问题?

java - 如何使用循环来创建新对象?

java - 如何配置避免加入 Javadoc 行的 Eclipse Java 格式?

java - 从 javadoc 中排除方法

java - 如何使用Java在SVN中提交文件?

java - 如何从 JCalendar 获取 JMonthChooser 字符串中的月份名称

java - java方法中需要分号

java - 调整 Builder 模式以进行方法调用

java - 在 javadocs 中包含图像