代码注释的价值：一份可勾选的清单
代码注释的价值最容易死在第二步——不是因为难，是因为一开始定得太满。
- 把标准写下来贴在看得见的地方，比记在脑子里有效。
- 记录只留一行：日期、做了没、一句话感受。
- 先做最小版本：一次十五分钟，连续两周，再谈优化。
关于代码注释的价值，市面上流传的说法不少，其中相当一部分只在理想条件下成立。下面写的都是能在家、在普通工作日里落地的部分。
把代码注释的价值当成一个要长期维护的系统，而不是一个要完成的任务，判断标准会完全不同。
先把前提说清楚：代码注释的价值的效果和条件强相关。同样的做法，换一个环境、换一个时间点，结果可能完全相反。
关于代码注释的价值，先讲前提
儿童、老人、孕期的做法要单独调整，剂量和强度都低一档。涉及用药时一律先问医生。
代码注释的价值不是在所有条件下都成立。空间、时间、身体状况、同住的人，任何一项不匹配，效果都会打折。
先说边界：如果说半天得不到想要的结果已经持续很久并且影响日常，别自己在家试，先找专业的人看。代码注释的价值解决的是日常维护，不是治疗。
先说清代码注释的价值的逻辑
代码注释的价值的底层逻辑是降低启动成本。人不是没有意志力，是被启动成本挡住了。把工具放在通勤路上，把动作拆到三分钟，启动就不再需要决心。
值得先弄清的一点：代码注释的价值不是万能钥匙。它能改善说半天得不到想要的结果，但改善幅度取决于你的具体条件，别指望它解决所有问题。
大多数人把代码注释的价值想复杂了。它真正的结构只有三段：判断现状、定一个最小动作、给它一个固定位置。三段里最容易缺的是第三段。
状态差的那天，把必做压到最小，才不会断。
从零开始做代码注释的价值
从最小动作开始：一次十五分钟，只做一个动作。把所有步骤都做全，反而在第两天就会放弃。
给自己设一个触发点，绑在已经固定的事情后面——比如晚饭后收拾完厨房，或者刷完牙。靠时间点容易漂，靠事件不容易。
把一个验证清单放到通勤路上。这一步听起来像废话，但它决定了后面三周的执行率，作用比任何技巧都大。
| 省力做法 | 常规做法 | 细致做法 | |
|---|---|---|---|
| 起步要花的力气 | 半天摸到门道 | 头一周都在适应 | 十五分钟内能开始 |
| 投入的钱 | 几十元的消耗品 | 一两百的一次性投入 | 手边现成的东西 |
| 多久有感觉 | 当天就有差别 | 一到两周见分晓 | 三到四周才稳 |
| 适合谁 | 时间很碎、想先试试 | 完全没接触过 | 准备长期做的人 |
| 最容易放弃的点 | 没人一起做 | 一开始定得太满 | 没有固定时间 |
| 半年后还做得到吗 | 靠提醒维持 | 已经长进日常流程 | 成了习惯，不用想 |
同一件事的三种力度，按自己的条件对号入座。
做代码注释的价值时的四个典型误判
还有一种看起来像努力的行为：反复研究方案，迟迟不开始。研究三小时，不如做十五分钟。
另一个坑是把标准定得太高。标准过高会导致「要么完美要么放弃」，而放弃的成本远比做一半高。
有人把代码注释的价值做成给别人看的样子，记录很漂亮，实际没做。这种自我欺骗最难发现，也最伤。
让代码注释的价值融进日常
给自己设一个下限：一周至少两次。低于这个数，习惯会退回去；高于这个数，多做的都是加分。
代码注释的价值能不能长期做，取决于它占不占脑子。占脑子的做法会被别的事挤掉，不占脑子的会变成默认。
把决策提前：周末决定下一周什么时候做，当天只负责执行。每次现场决定，等于每次重新开始。
- 每月十分钟：保留、修改、删掉各一项
- 把代码注释的价值写进日程，而不是待办清单
- 一次只改一个变量，其余先不动
- 先写好三分钟版本，等状态差的那天再用
- 每三个月删掉一个不必要的步骤
- 一个验证清单放在使用的地方，别收进柜子
代码注释的价值的四个检查点
做对的时候通常不觉得在坚持，只觉得「这就是我的做法」——那种状态就是成了。
检查方法不用复杂：每周记三行，一个月回头看一次。能看出趋势就够了，不需要精确数据。
检查一：能不能重复。做过三次以上还能保持同样顺序，说明方法立住了；第三次就变形，说明步骤太多。
代码注释的价值不是意志力问题，是流程设计问题。
关于代码注释的价值的常见问题
代码注释的价值的结果可靠吗？
当作初稿可靠，当作结论不可靠。数字、引用、法律和医疗相关内容必须自己核对。
代码注释的价值用久了会变懒吗？
会，如果每次都跳过验证。保留自己动笔和算一遍的习惯，是最便宜的保险。
代码注释的价值学起来难吗？
不难，但需要练。先把一个真实任务跑通，比看十篇介绍有用。
代码注释的价值能替代人吗？
能替代重复劳动，替代不了判断。越需要担责的部分，越要人来做最后一步。
写工具类内容五年，反对神化。 更多文章 →
