注释起着很重要的作用，但是如果可以的话，尽量不要使用注释，而是书写更多的描述性代码。这是因为在你修改代码的时候，注释往往会被忽视。因此我这样说：注释有时会骗人（有错误），因为它周围的代码已经改变，而它自己没有被修改。
图源：unsplash
有三种方法书写代码：
· 在代码中使用注释。
· 将注释写在单独的文件中。
· 书写自我说明的代码。
我来详细说明一下最后一点。下面是书写更多描述性代码的意义：
· 好好设计代码库，使它方便查找且结构合理。
· 不要尝试保存缩写字母。在对变量、类和函数命名的时候使用全称，比如不用wm用windowManager，不用rf用readFileToString。当你或者其他人间隔数月再看代码试图理解其意思时，这种命名方式会有很大帮助。
· 尽可能多地提取函数并让它们各司其职。根据其功能进行命名，比如，创建一个将文件读入字符串的函数，将其命名为readFileToString(String fileName)，不用仔细阅读代码就能明白它的作用。
最理想的情况是，你的代码由一系列这样的函数调用组成，读起来就像人类语言一样。只有在需要的时候，读者才会去深入理解，这些代码本身就有说明的作用。