不是为了写注释而写注释

注释消失的原因

  • 国内程序员的职业环境对加注释不友好,996
  • 看待注释的方式出现了变化,“好代码不需要注释”这种观点也是造成注释少的一个原因。
  • 注释没有规范,导致质量参差不齐,错误的注释,比没写注释还祸害人。

如何写注释

  • 复杂的业务逻辑
  • 晦涩的算法
  • 非常规的写法
  • 可能有坑却暂时没太好解决办法
  • 关于项目核心的接口、类和字段

猜你喜欢

转载自blog.csdn.net/bayinglong/article/details/128339103