Question

我班上有一个什么都没做的方法。

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

那个方法只是因为BankAccount将它作为抽象方法。每次有人提款时，BankAccount都会调用deductWithdrawalFees（）。它应该扣除提款费。

SpecialCheckingAccount类代表一个特殊支票账户，无需提取费用。

我的印象是每个方法都应该有一个javadoc。你怎么javadoc像这样的方法？

编辑：BankAccount类中的deductWithdrawalFees（）（抽象超类）有Javadoc（“扣除与余额存款相关的费用”）但我觉得它不太适用于空实现，其中没有任何技术上的扣除，并且费用不存在。因此，我认为继承javadoc并不能真正回答这个问题。

Answer 1

我会接受并展开它，解释为什么该方法的实现无效：“SpecialCheckingAccount类代表一个特殊的支票账户，没有提款费。”

来自@Andreas的建议：像这样的一个好的Java运行时库示例是AbstractList.set（int index，E element）的javadoc，它重复接口的javadoc并添加：此实现总是抛出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

你可以将推论值设为零以使其具有“功能”。然后在文件中指明特殊支票账户的目的是没有提款费用。

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

3 个答案: