起因是组里的一次 review：有人被要求给一段三十行的函数补注释，他反问「代码本身不是已经说清楚了吗」。
两边都有道理，于是把火拨旺了一点，摆到营地里来聊。
补充一句：这次争的不是「写不写」，而是「写到什么程度才算合格」——欢迎带着你最近写过最满意（或最想删掉）的一段注释来。
起因是组里的一次 review：有人被要求给一段三十行的函数补注释，他反问「代码本身不是已经说清楚了吗」。
两边都有道理，于是把火拨旺了一点，摆到营地里来聊。
补充一句：这次争的不是「写不写」，而是「写到什么程度才算合格」——欢迎带着你最近写过最满意（或最想删掉）的一段注释来。
代码说明「怎么做」，注释说明「为什么这么做」。前者三个月后还能读懂，后者三个月后一定忘干净。
需要靠注释解释逻辑，往往说明代码本身没写清楚。与其补注释，不如把命名和结构先理顺。
这条留言住在「代码篝火」。营地是大家聊天的地方，这里是一句话被单独留下、可以慢慢读的地方。