当很多前辈教育后辈应当多写注释的时候,当网络上充满了有关程序员从不写注释的段子的时候,这是一个非常有争议的话题。注释的确有其用途,但大部分情况下,程序员在滥用注释。我是反对夹杂在代码间的注释的,我认为注释应当从代码中独立出来――通常被称为文档。所以只有当非常必要的情况下,才应该添加注释,而且应当言简意赅。废弃的代码被弃用的代码应该被删掉,这些代码会非常影响阅读,而且它们一般又很长。如果这四个部分都是一个函数调用的话,那么函数名本身就是对逻辑的一种解释,读者可以快速地找到函数 B, 而不必在前 25 行中搜索做事情 B 的五行代码。

代码中到底应不应当写注释?

代码中到底应不应当写注释?

代码中到底应不应当写注释?