我们该不该写注释

我们平时在编码时总是伴随着代码与注释，已经成为了一直习惯，那我们应不应该去写注释呢？

要回答这个问题，我们需要首先来看我们平时写注释的动机，既然平时经常去写，肯定有写的理由。概括来讲，就是有一些代码无法说明的东西需要通过注释来表达出来，让阅读者更加方便理解。

最多就是对于代码的解释。基于这种情况，似乎理由显而易见，因为写了之后可以为代码带来更好的说明。那有没有不写注释又能够解释代码的方式呢，最常见的一种方式就是通过一些重构的方式以及合理的命名来实现。如果可以达到同样的效果，当然是通过代码来进行描述更合适，因为在修改代码之后肯定会对代码的名称进行同步的修改，而对于注释则会遗漏，这样的话就会导致本来是对代码进行解释的结果造成了误导（同步修改注释是一件比较耗时而且难以去实现的事情）。那如果没有办法通过代码的方式来进行说明的，就需要添加上注释，直到找到代码重构的方法。其次是由于语言的差异问题，就算可以用适合的英文名来说明，但是中英文之间的差异还是很难让阅读者一眼就知道代码的含义，因此加上简短的中文注释也有帮助。另外一个原因可能是对概念的不熟悉，如果是一些大家都熟知的概率，那就不需要去解释，例如汽车可以开，可以停，加油等等，而在一些其它的场景下对于抽象出来的概念通过注释也是一种比较好的解释方式，当然也可以通过使用docs来说明。

如果不是对代码的说明例如提醒（提醒要做什么、不该做什么）等，写注释也是有好处，虽然也可以通过外部文档的方式来说明，但是没有注释来的更加的直接方便。

因此，该不该写注释还是依场景来判断，最好是可以通过代码的方式来解释，然后加上一些概念的解释以及简短的中文翻译，如果还不足以说明再通过注释来补充（必须是通过思考之后的）。