写给未来自己的代码注释

代码已经表达了「做了什么」，注释更适合记录「为什么这样做」。解释一行简单赋值的注释，很快就会和代码一起过时。

值得留下的上下文包括约束来源、看似奇怪的兼容处理、取舍过的方案，以及未来修改时需要重新验证的假设。

注释也需要维护。代码行为改变时，如果注释仍然描述旧行为，它会比没有注释更容易误导读者。

写注释前先考虑是否能通过更准确的命名或更小的函数表达意图。那些仍无法从代码中看出的决策，再用简短文字留下来。