匿名对象方法的Javadoc

适当和有用地记录匿名对象函数的最佳方法是什么？我做一些编程与斯奥（API here），并有一些代码看起来是这样的：匿名对象方法的Javadoc

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

来源

2012-01-10 Nate Glenn

你的交流对象是谁？如果是外部人员，那么该方法不需要任何文档，如http://stackoverflow.com/a/8797414/348975所解释的那样。如果是内部人员，那么他们可以直接阅读源代码。 – emory 2012-01-10 01:24:30

该方法根本不需要任何文档，因为它是接口的实现，并且应该记录该接口。接口的实现依照那个行为。

来源

2012-01-10 01:13:23 fivedigit

这个特定的接口用于通用处理程序;处理程序可以执行程序员想要的任何操作。 – 2012-01-10 01:25:36

@NateGlenn在这种情况下，JavaDoc注释的最佳位置将在functionBlah方法中。此方法的用户不需要知道或关心您是否使用匿名类实现了该方法。 – emory 2012-01-10 01:34:17

+1 - 如果类需要javadoc注释，它不应该是一个匿名类。 – 2012-01-10 02:13:34

匿名对象方法的Javadoc

回答

相关问题