读书笔记（代码大全）

代码块注释

• 注释应表达代码的意图
• 注释代码时应注重 为何做(why) 而不是 怎么做(how)
• 用注释为后面的内容做铺垫
• 说明非常规做法。
• 将主次注释区分开。在次要注释前加省略号，主要注释以正常方式编排

• 高效注释之关键

  • 采用不会打断或抑制修改的注释风格
  • 用高层次的伪代码减少注释时间
  • 将注释集成到你的开发风格中