Maybe Comments _Should_ Explain 'What'
4 months ago
- #programming
- #clean-code
- #code-comments
- 注释应该同时解释'做什么'和'为什么'，而不仅仅是'为什么'
- 描述性变量名可以减少对'做什么'注释的需求，但不能完全消除上下文切换
- 将'为什么'存储在提交信息或测试中会使查找和理解代码背后的逻辑变得更困难
- 提取方法使代码更简洁的同时，在调试或理解流程时可能会引入上下文切换
- 位置恰当的'做什么'注释有时比提取方法更能有效帮助理解代码
- 本文反对全盘否定'做什么'注释的观点，认为它们存在合理的应用场景