注释
正如我们在 代码结构 一章所了解到的那样,注释可以是以 // 开始的单行注释,也可以是 /* … */ 结构的多行注释。
我们通常通过注释来描述代码怎样工作和为什么这样工作。
乍一看,写注释可能很简单,但初学者在编程的时候,经常错误地使用注释。
糟糕的注释
新手倾向于使用注释来解释“代码中发生了什么”。就像这样:
// 这里的代码会先做这件事(……)然后做那件事(……)
// ……谁知道还有什么……
very;
complex;
code;
但在好的代码中,这种“解释性”注释的数量应该是最少的。严格地说,就算没有它们,代码也应该很容易理解。
关于这一点有一个很棒的原则:“如果代码不够清晰以至于需要一个注释,那么或许它应该被重写。”
配方:分解函数
有时候,用一个函数来代替一个代码片段是更好的,就像这样:
function showPrimes(n)