Comments in the code vs PR description
devblogs.microsoft.com原文 ↗
Raymond Chen 以信息寿命区分代码注释和 PR 描述:未来维护者理解当前约束、反直觉实现与不可破坏条件所需的解释,应留在代码附近;探索过程、评审争论和被放弃方案属于变更历史。只写 PR 会让代码离开托管平台后失忆,把整段讨论塞进注释又会让过期过程遮蔽当前事实。判断标准是“这段信息在实现成为现状后是否仍然成立”。
–浏览
评论 · Comments