未实现且仅抛出 RuntimeException 的方法的 Javadoc

Question

我在 superclass 中定义了一个方法，我没有在我的扩展中实现这个方法 class:

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

我的疑惑是用 Javadoc 写什么。通常，如果实现了该方法，我们只需使用一个简单的：

/** {@inheritDoc} */

但我想明确说明该方法未实现，不应使用。你会在这里写什么？

也许：

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

或者也许：

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

Answer 1

没有通用标准，但您可以模仿 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 库——我不认为它与我们正在谈论的内容特别相关，但我把它留在里面而不是修改我的代码m 引用)

未实现且仅抛出 RuntimeException 的方法的 Javadoc

Javadoc for a method that is not implemented and just throws a RuntimeException

java

javadoc