Javadoc для метода анонимного объекта - PullRequest
Новая
       32

Javadoc для метода анонимного объекта

3 голосов
/ 10 января 2012

Каков наилучший способ правильно и полезно документировать функцию анонимного объекта?Я занимаюсь программированием с помощью Soar (API здесь ), и у меня есть код, который выглядит примерно так: 

/**
 * 
 * @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 Ответ

2 голосов
/ 10 января 2012

Метод не должен вообще нуждаться в документации, так как это реализация интерфейса, и этот интерфейс должен быть задокументирован.Реализация интерфейса ведет себя в соответствии с этим.

...