用“新人接手的认知成本”找难懂代码并给简化方案
- 作者
- 数字生命卡兹克 (@Khazix0918)
- 标签
解决什么问题
代码越来越难维护时用:假设明天来一个聪明但不了解项目的新工程师,评估他要花多大力气才能看懂,借此揪出命名混乱、抽象过度、职责不清的代码。
大白话:“认知成本”= 看懂一段代码需要脑子里先装进多少背景知识。
Prompt
原文(卡兹克第 8 条):
假设明天有一个完全不了解项目、但是能力很强的工程师来接手。请评估他理解整个项目需要付出的认知成本,找出那些命名混乱、抽象过度、职责不清晰、需要大量上下文才能理解的代码,并提出简化方案。
可选补充(本库加的约束,非原文):
按影响大小排序,每条给出具体文件和符号名;先只出报告和简化方案,不要直接改代码。
已知坑 & 评论区改进
- “命名混乱比抽象过度更伤人,名字起歪了第一眼就走偏。”—— @spb_musketeer(他也说这条比第 7 条用得更多)
- “拿新同事接手要花多少认知成本当标尺,烂代码一下子就藏不住了”。—— @YunaElira
- 未读到具体翻车案例。
来源
标签
重构/降复杂度