为何要写注释？

 

看到很多人喜欢写注释，当然也有很多人不喜欢写。

很多人喜欢写复杂的文档，甚至做了漂亮的图片来说明问题，花了相当大的精力去文档上面。

为什么？

写文档又不能运行，对不？

写文档的作用我想主要是用来整理思路。人类的智力有限，尤其是记忆力有限，因此需要很多外部存储体来帮助我们缓冲“中间数据”。

那些精心制作的文档，看上去好像没啥作用，纯浪费精力，但是如果没有这些精美清晰的文档，你的思路会一团糟，结果花了更多时间在debug之上。

做文档的人都是聪明人，任何时候，写文档都比写程序要容易得多，因为文档可以容错，格式可以自由。

文档也有一个要求，那就是你对编码要有信心，如果你写得文档和编码能力差太远，根本无法实现文档描述的东西，或者文档描述的东西不是实际编码所能做到的事情，这种编码能力低下导致的错误文档，再漂亮也是没意义的。

因此，不编码，写文档，反而对编码能力是一个考验。这可能就是为什么新手不喜欢写文档，因为根本心中无码，不知道写的东西能不能和程序对上号来，写了也等于白写，干脆就不写。

解决编码能力不足的问题，除了经验积累没有什么好的方法。但是有很多人，对编码已经较为熟悉了，还是不愿意写文档，因为自信自己能够“直接”解决问题，也就不屑于写文档。但是你要明白，你“直接”解决问题，实际上也必然是先构建思路，然后编码，只是你把思路放在脑海里，没有存档罢了。这造成的后果是将来自己都看不明白自己的代码。文档并不费劲，文档只是将思路存档的过程，让一些模糊的观点得到加强的过程，这是一种解题技巧，就如我们小学时候在纸上画算式，画示例图，这些工具弥补了我们记忆力不足的缺点。