对于什么都不做的方法，您为 javadoc 编写了什么？

Question

我的 class 中有一个方法什么都不做。

public class SpecialCheckingAccount extends BankAccount
{
    public void deductWithdrawalFees()
    {}
}

该方法之所以存在，是因为 BankAccount 将其作为抽象方法。每次有人取款时，BankAccount 都会调用 deductWithdrawalFees()。应该是要扣取款手续费的。

SpecialCheckingAccount class 表示没有取款费用的特殊支票帐户。

我的印象是每个方法都应该有一个 javadoc。你如何用 javadoc 编写这样的方法？

编辑：BankAccount class（抽象超级class）中的 deductWithdrawalFees() 有 Javadoc（"Deduct the fees associated with making a deposit from the balance"），但我觉得它不太适用于空的实施，技术上没有扣除任何费用，并且不存在费用。因此，我不认为继承 javadoc 真的是这个问题的答案。

Answer 1

我会接受它并对其进行扩展，解释为什么该方法与一个不执行任何操作的实现一起存在："The SpecialCheckingAccount class represents a special checking account that doesn't have a withdrawal fee."

来自@Andreas 的建议：一个很好的 Java 运行时库示例是 AbstractList.set(int index, E element) 的 javadoc，它重复接口的 javadoc 并添加： This implementation always throws an UnsupportedOperationException。 --- 要使用相同的措辞，您的 javadoc 可能会说：这个实现什么都不做，因为一个特殊的支票账户没有提款费。

Answer 2

为什么要写 Javadoc？ BankAccount.deductWithdrawalFees() 应该有一个，这应该是所有需要的。但是，我会像这样记录空块：

public class SpecialCheckingAccount extends BankAccount
{
    @Override
    public void deductWithdrawalFees()
    {
        // nop: SpecialCheckingAccount has no withdrawal fee.
    }
}

您还应该添加 @Override注释。

Answer 3

您可以将扣除额设置为零值 "function"。然后在文档中注明特殊支票账户的目的是没有取款费用。

对于什么都不做的方法，您为 javadoc 编写了什么？

What do you write for javadoc for a method that does nothing?

java

javadoc