Question

很多程序员不喜欢写注释，因为要写出好的注释感觉好像要花很多工夫。当作者有了这种“作者心理阻滞”，最好的办法就是现在就开始写。因此下次当你对写注释犹豫不决时，就直接把你心里想的写下来就好了，虽然这种注释可能是不成熟的。

例如，假设你正在写一个函数，然后心想：“哦，天啊，如果一旦这东西在列表中有重复的话会变得很难处理的。”那么就直接把它写下来：

//哦，天啊，如果一旦这东西在列表中有重复的话会变得很难处理的。

看到了，这难吗？它作为注释来讲实际上没那么差——起码比没有强。可能措辞有点含糊。要改正这一点，可以把每个子句改得更专业一些：

·“哦，天啊”，实际上，你的意思是“小心：这个地方需要注意”。

·“这东西”，实际上，你的意思是“处理输入的这段代码”。

·“会变得很难处理”，实际上，你的意思是“会变得难以实现”。

新的注释可以是：

//小心：这段代码不会处理列表中的重复（因为这很难做到）

请注意我们把写注释这件事拆成了几个简单的步骤：

1.不管你心里想什么，先把它写下来。

2.读一下这段注释，看看有没有什么地方可以改进。

3.不断改进。

当你经常写注释，你就会发现步骤1所产生的注释变得越来越好，最后可能不再需要做任何修改了。并且通过早写注释和常写注释，你可以避免在最后要写一大堆注释这种令人不快的状况。