注释

注释是一种重要的文档形式，可以帮助其他开发人员理解代码的意图和实现方式。在编写注释时，应该避免写“是什么”的注释，因为代码的命名和结构应该能够直接反映出来。相反，应该多写“为什么”的注释，以便其他开发人员更好地理解代码的逻辑和背景。写“为什么”的注释还有一个好处，就是能够为后来的维护者提供一个优化的切入点。注释太多和太少都有问题，应该适量添加必要的注释。

注释的内容主要包含这样三个方面：做什么、为什么、怎么做，

在注释中，关于具体的代码实现思路，我们可以写一些总结性的说明、特殊情况的说明。这样能够让阅读代码的人通过注释就能大概了解代码的实现思路，阅读起来就会更加容易

对于有些比较复杂的类或者接口，我们可能还需要在注释中写清楚“如何用”，举一些简单的 quick start 的例子，让使用者在不阅读代码的情况下，快速地知道该如何使用

注释太多和太少都有问题。太多，有可能意味着代码写得不够可读，需要写很多注释来补充。除此之外，注释太多也会对代码本身的阅读起到干扰。而且，后期的维护成本也比较高，有时候代码改了，注释忘了同步修改，就会让代码阅读者更加迷惑。当然，如果代码中一行注释都没有，那只能说明这个程序员很懒，我们要适当督促一下，让他注意添加一些必要的注释。