有用和无用的代码注释介绍

61 阅读1分钟

吉姆-尼尔森

如果有人说一个评论没有增加任何价值,我会问:对谁来说?

就我个人而言,我从来不喜欢写明显的注释是不好的做法的建议--可能是因为我一直在写明显的注释。

Jim展示了一些 "与代码本身的保真度相同的代码注释 "的例子,这些是对代码注释最难的呼吁。

// this function adds two numbers
function add(a, b) {
  return a + b;
}

很容易指着这一点说它_没有_用。我倾向于不留下这种类型的注释,但吉姆质疑这一点也是公平的。注释可以用于广泛的人,他们可能在某些时候与该代码互动,所以为什么要把关呢?

[......]评论在被阅读和被编写时可以起到非常不同的作用。这几乎是两种不同的活动。

我想补充的是,在重新审视旧代码和积极工作时,它们的作用是不同的。另外,当你试图进行代码审查与直接贡献时,也是不同的。