看到标题，我知道你能够会想：“我为什么要避免代码注释，这难道不是一件坏事吗？”。是的，写注释在大少数状况下是有用的。但是，请留意，我说的是“在大少数状况下”，由于有一些状况下，你不应该写注释。

还不置信？那让我通知你：写注释有时会坏事！会招致坏代码！

请允许我用一句名言来末尾我的论证：

不要注释坏代码——重写吧。——Brian W. Kernighan and P. J. Plaugher

这句话给我流下了十分深入的印象。细心想一想，有多少次你注释你的代码，只是由于担忧本人未来再回过头来阅读的时分能够会不了解它的意思？至少都做过一次吧。坦率地说，我有很屡次是由于这个缘由才注释的，尤其是在那些我还是重构和编写洁净代码的新手的日子里。

那么，为什么这样的注释反而不好呢？简而言之是由于，我们会由于有注释而听任编写坏的代码！正如你所看到的，注释有时分反而鼓舞了我们去写一些不整洁的代码。

另一个缘由是由于注释会误导我们。有多少次你曾经改动了代码，却忘了改旁边的注释？别否认，这种事时常发作。这就是为什么你常常听到这样一句话，“真理只存在于代码中”。

那么，什么时分你不应该写注释呢？

有一个阅历规律就是，无论何时你发现本人要运用注释来解释这段代码是用来干什么的时分，那么基本上就是你的代码需求重构以变得更整洁的时分。

典型的处置方案

如今你知道为什么有时分反而要避免写注释了，那么有什么处置办法吗。理想上，目前还没有一个有效的处置方案，但是你可以清洁你的代码，这样你（以及其别人）就可以在没有注释的状况下也能了解它了。

为了用可读的代码交流掉注释，通常我们的典型处置办法是运用提取办法重构（Extract Method refactoring）。这种重构方式是我最喜欢的。对此我也写过一篇博客，外面有残缺的例子：《Break Your Method Into Smaller Ones》。

下面让我们看一个复杂阐明如何提高你的代码，从而束缚注释的例子。

<php 

 

// Check to see if the customer can get free product 

if ($customer->isPremium() and $customer->numberOfPurchases > 8) { 

 

} 

 

// OR 

 

if ($customer->canGetFreeProduct()) { 

 

} 

我希望你能留意到这两个条件语句之间的差异。哪一个更整洁？很清楚第二个更整洁，更好。这是由于，首先，可以删除注释，由于我们看代码就明白了意 思。其次，也是最重要的一点是，我们提取了反省客户能否值得取得收费产品的逻辑到它的办法中，这是一件坏事，特别是当你想要在运用顺序中再次运用它的话。

关于更详细的例子，我引荐你阅读我以前宣布过的文章。

结论

请允许我用一个免责阐明来完毕这篇文章。我不支持注释。注释在大少数状况下是十分有用的，尤其是在开源项目中。

我想说的是，你不应该为你的坏代码注释。请记住，“真理只存在于代码中”。

译文链接：
英文原文：When Should You Avoid Commenting Your Code?

【编辑引荐】

创业CEO：如何避免共同兴办人危机

创业者应该如何避免堕入“成功圈套”

顺序员应该避免的5种代码注释

薪资谈判应该避免的7个错误

Java中的常量：如何避免反形式

什么时分应该避免注释代码

(责任编辑：admin)