Javadoc用于匿名对象的方法

时间:2012-01-10 01:11:13

标签: 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的方法,我真的不想为每个处理程序编写单独的类,仅用于文档目的。

1 个答案:

答案 0 :(得分:2)

该方法根本不需要任何文档,因为它是接口的实现,并且应该记录该接口。接口的实现表现如下。