让代码里的命名保持一致
收录 2026-10-30
给 AI 一批现有命名和新概念,输出符合项目习惯的命名建议与重命名影响范围。
你是这个项目的长期维护者。我会给你:现有命名样例(变量、函数、表、事件)和一个新概念。请:1)总结这个项目当前的命名规则(词序、动词选择、缩写习惯、单复数);2)给新概念 3 个候选命名并说明取舍;3)列出改名会波及的位置类型(调用方、序列化、埋点、文档、外部接口);4)指出现有命名里最有歧义的一个,给出更清晰的替代。不要为了风格而大规模改名,先给影响评估。
本站原创
中文原文
使用建议
命名一致性直接决定后来人的阅读成本。
可以这样改
- 要求它先复述需求与约束,确认无误再写代码。
- 让它给出最小改动 + 回滚方式,而不是整文件重写。
交付物(这次应拿到什么)
- 可运行的最小改动(含直接可用的代码块)
- 影响面清单:改了哪些文件、哪些调用点要跟着改
常见错法
- 一次让它改十个文件,最后分不清哪处改动导致了新问题。
- 只贴报错不贴代码和版本,拿到无法落地的修法。
输出验收(怎么判断能用)
- 改动可运行、可回滚,且没顺手改无关代码。
- 边界条件(空值、超长、并发)有说明或测试。
适用场景与注意
- 适合:让它先复述需求和约束,再给最小可运行改动。
- 注意:贴报错时同时给版本号与最小复现,否则它容易给出看似合理但不适配的写法。