Javadoc是一个未实现的方法,只是抛出一个RuntimeException

时间:2016-11-02 14:22:02

标签: java javadoc

我在超类中定义了一个方法,我在扩展类中没有实现这个方法:

@Override
public String[] getParams() {
    throw new UnsupportedOperationException("Not implemented");
}

我怀疑是作为Javadoc写的。通常,如果实现该方法,我们只需使用一个简单的:

/** {@inheritDoc} */

但我想明确表示该方法未实现且不应使用。你会在这里写些什么?

也许:

 /** 
 * Method not implemented
 * {@inheritDoc} */

或者也许:

/**
 * Not implemented.
* 
* @throws UnsupportedOperationException.
*/

1 个答案:

答案 0 :(得分:2)

没有通用标准,但您可以模仿Guava开发人员对不可变集合的不受支持的操作所做的事情。例如来自com.google.common.collect.ImmutableList.java

 /**
   * Guaranteed to throw an exception and leave the list unmodified.
   *
   * @throws UnsupportedOperationException always
   * @deprecated Unsupported operation.
   */
  @CanIgnoreReturnValue
  @Deprecated
  @Override
  public final E set(int index, E element) {
    throw new UnsupportedOperationException();
  }

我会说@inheritDoc应该,因为它可能描述了一些行为,你的异常抛出实现不会 做。

@CanIgnoreReturnValue来自ErrorProne图书馆 - 我不认为它与我们所谈论的内容特别相关,但我把它留在了而不是修改我引用的代码