Wetts's blog

Stay Hungry, Stay Foolish.

0%

代码整洁之道-第17章-味道与启发

注释

  1. 不恰当的信息

让注释传达本该更好地在源代码控制系统、问题追踪系统或任何其他记录系统中保持的信息,是不恰当的。例如,修改历史记录只会用大量过时而无趣的文本搞乱源代码文件。通常,作者、最后修改时间、SPR数等元数据不该在注释中出现。注释只应该描述有关代码和设计的技术性信息。

  1. 废弃的注释

过时、无关或不正确的注释就是废弃的注释。注释会很快过时。最好别编写将被废弃的注释。如果发现废弃的注释,最好尽快更新或删除。

  1. 冗余注释

如果注释描述的是某种充分自我描述了的东西,那么注释就是多余的。例如:

1
i++; // increment i

另一个例子是除函数签名之外什么也没多说(或少说)的Javadoc:
1
2
3
4
5
6
/**
* @param sellRequest
* @return
* @throws ManagedComponentException
*/
public SellReponse beginSellItem(SellRequest sellRequest) throws ManagedComponentException

  1. 糟糕的注释

如果要编写一条注释,就花时间保证写出最好的注释,字斟句酌。使用正确的语法和拼写。别闲扯,别画蛇添足,保持简洁。

  1. 注释掉的代码

看到注释掉的代码,就删除它!源代码控制系统会记得它,如果有人真的需要,可以签出比较前的版本。

函数

  1. 过多的参数

函数的参数数量应该少。没参数最好,一个次之,两个、三个再次之。三个以上的参数非常值得质疑,应坚决避免。

  1. 输出参数

输出参数违反直觉。读者期望参数用于输入而非输出。如果函数非要修改什么东西的状态不可,就修改它所在对象的状态好了。

  1. 标识参数

布尔值参数大声宣告函数做了不止一件事。它们令人迷惑,应该消灭掉。

  1. 死函数

永不被调用的方法应该丢弃。