写出让人看得懂、改得动、放得心的代码 —— 从第一天开始
每一站都为「刚入职的你」量身定制,点击卡片可直接跳转
质量、协作、可维护性——审查不只是"挑毛病"
超长函数、魔法数字、重复代码……前后对比一看就懂
对事不对人,话怎么说、流程怎么走
提取函数、重命名、消除重复——三个最常用的动作
提交代码前,花 5 分钟过一遍这份清单
别把它当成「被挑刺」,它是团队互相帮忙的日常仪式
再细心的开发者也有盲区。多一双眼睛,逻辑漏洞、边界错误、安全隐患往往在上线前就被拦下——修复成本几乎是最低的。
把问题拦在上线前通过互相阅读代码,你能了解其他模块怎么写、团队的惯例是什么;别人也认识了你。人员休假、离职时,代码不会变成「无人区」。
代码是团队的共同语言统一的规范让「半年后的你自己」也能看懂今天的代码。规范的代码改起来放心、扩展起来迅速,技术债不再悄悄滚雪球。
今天多写注释,明天少掉头发一个坏味道不可怕,可怕的是它被不断复制、放大
某个函数图省事,
写死了几个魔法数字
后来的同事「参考」
同样的写法继续堆
没人敢动的核心模块,
改一行、崩三处
最后只能推倒重写,
耗时数倍还耽误业务
症状:一个函数几百行、缩进套缩进、注释比代码还多——没人敢改
症状:代码里凭空出现 0.88、60、3……三个月后没人知道它们是什么意思
症状:两段几乎一样的代码分居两处——改 bug 时永远会漏掉一处
评审时看到这些信号,就可以礼貌地提出来了
if 套 if 套 for 套 if,读到第五层已忘记开头
一个函数传 8 个参数,调用时全靠数逗号
函数叫 get_data 却顺手写了数据库
大段代码被注释掉「以备后用」,一留三年
一个 utils.py 塞了三千行,什么都往里放
改一个小需求要动 6 个文件的同一段逻辑
同一个建议,不同的说法,效果天差地别
一次评审的体量越小,质量越高、速度越快
一个需求一个分支
PR 控制在 400 行内
提交前自己先过一遍清单
别让低级问题浪费评审
PR 描述写清「改了什么、
为什么改、如何验证」
评审意见 24~48h 内响应
改完请求复审
达成一致后 Approve
及时合并、删除分支
当代码需要一段注释才能解释时,就该把它提炼成函数了
好名字省掉一半注释;起名是最便宜的「文档」
同一逻辑只写一次,改起来才不会顾此失彼
全部打勾再提评审,你的 PR 通过率会明显上升