文章

如何写好代码?

如何写好代码?

博主从18年9月摸爬滚打至今,在如何写好代码的这个问题上,也是从 懵懵懂懂 -> 恍然大悟

如何写好代码?

对于这个问题我相信每个人都有不同的见解,或遵循XXX规范设计模式详细的注释等等

基于最近这三年的实际工作体验来讲我认为 如何写好代码? 并不是一个很抽象很复杂的一个问题,编写好的代码是有迹可循的。

我的结论如下:

  1. 命名规范:命名规范是基础,见其名知其意,避免过长命名,适当使用缩写 prefixsuffix
  2. 结构简单/组织清晰:易读的前提就是整体实现功能的代码结构简单,函数尽可能扁平化Impl内函数的嵌套调用最好在三层以下,比起少量重复而言 ,简单易读更为重要(这点尤为深刻)。不能为了设计模式而设计模式
  3. 适当的函数封装:函数封装优先于类封装
  4. 良好的沟通和定期Review:思维互换、交流心得

1. Review大法好

若项目是同一个人开发、维护,不考虑后续人接手的情况下,毫无好坏之分,只要功能实现程度高、性能好、稳定不崩,那就是好代码。但往往事与愿违,会持久的项目基本都需要一个团队进行开发、维护、持续交付。 人多是屎山代码形成的其一原因,每个人的喜好、想法、风格尽不相同,所共同写出来的代码天差地别(略微夸张),有些人技艺高超(设计优雅,易扩展,但代码略显青涩),有些人不尽人意(囫囵吞枣、结构混乱大锅炖)。 Review 则可以打破人与人之间的信息壁垒,互相交流心得,互相学习,在一个团队内,Review的次数在一定程度上决定了团队内成员代码风格统一的概率。

本文由作者按照 CC BY 4.0 进行授权

© Mrhan. 保留部分权利。

本站由 Jekyll 生成,采用 Chirpy 主题。