F10入门

注释必要性审查

20 分钟每次代码审查

格式:检查代码中的注释是否有价值。

需要注释的

  • 解释"为什么"(业务逻辑的原因)
  • 解释复杂算法的思路
  • 说明临时解决方案(为什么这样做 + 什么时候修复)

不需要注释的

  • 解释"做了什么"(代码本身应该够清晰)
  • 被注释掉的代码(应该删掉,Git 会记住)
  • 显而易见的事情(x = x + 1 // x 加 1

我的笔记