当前位置: 首页 > article >正文

Code Review Item

▶︎ 对于代码格式规范,100%严格执行,眼中容不得一点沙。

▶︎ 文件绝不能超过 800 行,超过一定要思考怎么拆文件。工程思维,就在于拆文件的时候积累。

▶︎ 函数对决不能超过 80 行,超过一定要思考怎么拆函数,思考函数分组,层次。工程思维,就在于拆文件的时候积累。

▶︎ 代码嵌套层次不能超过 4 层,超过了就得改。多想想能不能 early return。工程思维,就在于拆文件的时候积累。

▶︎ 从目录、package、文件、struct、function 一层层下来 ,信息一定不能出现冗余。比如 file.FileProperty 这种定义。只有每个“定语”只出现在一个位置,才为“做好逻辑、定义分组/分层”提供了可能性。

▶︎ 多用多级目录来组织代码所承载的信息,即使某一些中间目录只有一个子目录。

▶︎ 随着代码的扩展,老的代码违反了一些设计原则,应该立即原地局部重构,维持住代码质量不滑坡。比如:拆文件、拆函数、用 Session 来保存一个复杂的流程型函数的所有信息、重新调整目录结构。

▶︎ 基于上一点考虑,我们应该尽量让项目的代码有一定的组织、层次关系。我个人的当前实践是除了特别通用的代码,都放在一个 git 里。特别通用、修改少的代码,逐渐独立出 git,作为子 git 连接到当前项目 git,让 Golang 的 Refactor 特性、各种 Refactor 工具能帮助我们快速、安全局部重构。

▶︎ 自己的项目代码,应该有一个内生的层级和逻辑关系。flat 平铺展开是非常不利于代码复用的。怎么复用、怎么组织复用,肯定会变成“人生难题”。

▶︎ 如果被 review 的代码虽然简短,但是你看了一眼却发现不咋懂,那就一定有问题。自己看不出来,就找高级别的同学交流。这是你与他人共同 review 代码、共同成长的宝贵时刻。

▶︎ 日志要少打,要打日志就要把关键索引信息带上,必要的日志必须打。

▶︎ 有疑问就立即问,不要怕问错,让代码作者给出解释,不要怕问出低级问题。

▶︎ 不要说“建议”,提问题就直接提,有错误就得改!

▶︎ 请积极使用 trpc。总是要和老板站在一起!只有和老板达成的对于代码质量建设的共识,才能在团队里更好地做好代码质量建设。

▶︎ 消灭重复!消灭重复!消灭重复!


http://www.kler.cn/news/359169.html

相关文章:

  • 2024年CRM系统全景:领先品牌的深度解析与企业选择指南
  • 大数据新视界 --大数据大厂之图数据库与大数据:挖掘复杂关系的新视角
  • 嵌入式与 YOLO 目标检测的完美融合
  • Mac ARM 本地运行 Mini-Omni 记录
  • Redis 性能优化选择:Pika 的配置与使用详解
  • 备考408——数据结构基础知识
  • 模型驱动架构(MDA)设计方法及其应用分析
  • C++面试速通宝典——28
  • RestTemplate基本使用之HTTP实现GET请求和POST请求
  • Pymysql中Mysql连接默认会开启事务处理-数据表名行数列表SQL以及python中的日志模板 logoru 及常用参数配置解析
  • 内网穿透之Linux系统安装神卓互联【超详细,小白一看就会】
  • 2024-moectf Web WP
  • docker配置加速器
  • git分支模型
  • 情绪稳定!别再让Git合并冲突影响你工作了
  • 音视频入门基础:H.264专题(19)——FFmpeg源码中,获取avcC封装的H.264码流中每个NALU的长度的实现
  • [论文阅读]Large Language Models Are Reasoning Teachers
  • 《深度学习》OpenCV 人脸检测、微笑检测 原理及案例解析
  • commvault测试(1):cv10使用辅助拷贝实现不同MA的数据同步
  • 在文件里引用目录文件下的静态资源图片不显示