写好代码注释

3 min read
# 观点
View

编码时写注释的思路

  1. 这是什么
  2. 应用场景和解决问题的解决方案(为什么使用)
  3. 如何快速使用(基本使用)
  4. 技术细节和原理(进阶阅读)
  5. 其它

    • 贡献者
    • license

“Wow,我真是个天才,写出了如此完美的代码。”

一个月以后回头看,

“当时这里我为什么要这样写啊。”

---- 来自鬼才程序员迷之自信与质疑。


把为什么这样做的想法和思路记下来,是一种习惯,也是一种责任。不仅仅是代码注释,更是人生的注释。记录存在过的痕迹。

每一行代码,都在反映人生的态度和觉悟,需要认真对待。

当然这不是谁都会做到,自律的人不多,更多的是随便应付的交作业。


经过不断沉淀的注释,构成可持续维护的项目,这也是一种习惯和技术积累。

对于个人来说,有一套成熟的开发体系,这是个人的开发积累。毕竟业务开发千变万化,只要做应用开发,总有些不变的开发理念,技术原理,前人总结和自身经验总结,都需要不断学习。但是有时候某些经验也会成为绊脚石,所以需要持续实践来改进和接触新想法,也要谦虚。

对于公司来说,则基于对每个人的约定。如何让大家合作更融洽更有效率,产品不因人员变动而废弃,新人可以快速接入,不能只有口头的说说,要有成文的规则,否则最后的结果也是能预见的:“人离开项目则废弃”。这是不可持续发展的,无论对于个人还是团体。


无规则不成方圆,没有最好的,只有适合的

  • 开发流程

    • 代码提交方式
    • 代码格式规范(用 airbnb 或者 google 的)
  • 基础框架
  • 脚手架
  • 部署流程

写代码只是刚刚开始,还有很多需要学习。

Table of Contents