gpt4 book ai didi

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

转载 作者:行者123 更新时间:2023-11-30 08:31:59 25 4
gpt4 key购买 nike

我在父类(super class)中定义了一个方法,但我没有在我的扩展类中实现这个方法:

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

我的疑问是用 Javadoc 写什么。通常,如果实现了该方法,我们将只使用一个简单的:

/** {@inheritDoc} */

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

也许:

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

或者也许:

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

最佳答案

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

关于未实现且仅抛出 RuntimeException 的方法的 Javadoc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40382305/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com