4.注释

注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。

代码在变动,注释却并不总是随之变动。

真实只在一处地方有:代码。只有代码能忠实地告诉你他做的事。那是唯一真正正确的信息来源。所以,尽管有时也需要注释,我们也该多花些心思尽量减少注释量。

如果你决定写注释,就要花必要的时间确保写出最好的注释。

直接把代码注释掉是讨厌的做法。别这么干!

短函数不需要太多描述。为只做一件事的短函数选个好名字,通常要比函数头注释要好。


提要

results matching ""

    No results matching ""