【问题标题】:Javadoc for method of anonymous object匿名对象方法的Javadoc
【发布时间】:2012-02-06 12:25:33
【问题描述】:

正确有效地记录匿名对象的函数的最佳方法是什么?我正在使用 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 的方法,我真的不想为了文档目的而为每个处理程序编写单独的类。

【问题讨论】:

  • 谁是您沟通的目标受众?如果是局外人,则该方法不需要stackoverflow.com/a/8797414/348975 解释的任何文档。如果是内部人员,可以直接看源码。
  • 嗯,这是真正的 emroy。我匿名实例化的 java.lang.Runnable 理论上不应该引起调用封闭方法的开发人员的兴趣。

标签: java methods javadoc anonymous-class


【解决方案1】:

该方法根本不需要任何文档,因为它是接口的实现,并且应该记录该接口。接口的实现就是按照这个来实现的。

【讨论】:

  • 这个特殊的接口用于通用处理程序;处理程序可以做程序员想做的任何事情。
  • @NateGlenn 在这种情况下,JavaDoc cmets 的最佳位置是在 functionBlah 方法中。此方法的用户不需要知道或关心您是否使用匿名类实现了该方法。
  • +1 - 如果该类需要 javadoc cmets 它不应该是匿名类。
  • 我不同意。如果内部类是java.lang.Runnable(这很常见)怎么办?我个人想从高层次上了解 Thread 的作用,以及为什么它是一个单独的线程。阅读 Oracle.com 上的 javadoc 不会告诉你答案。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2013-06-07
  • 1970-01-01
  • 1970-01-01
  • 2012-06-04
  • 2017-04-07
  • 1970-01-01
相关资源
最近更新 更多