核心哲学:清晰度 > 趣味性
“尊重他人的大脑,不要让人在凌晨两点查 Bug 时还要猜你的工具是做什么的。”
✅ 准则 1:功能直觉(Descriptive First)
- 公式:
[操作对象] + [动作/属性] + [类别] - 例子:
http-request-validator(好过Zephyr)db-connection-pool(好过Hydra)file-sync-service(好过Hermes)
✅ 准则 2:善用复合词与后缀
- 添加上下文: 如果名字太普通,通过后缀明确性质。
- 常用后缀:
-cli,-lib,-api,-db,-parser,-middleware,-util - 例子:
auth-casbin(比单纯的Casbin更有辨识度)
✅ 拥抱冗长(Embrace Verbosity):
- 在调试生产事故时,一个长而清晰的名字(如
auth-token-generator)远比一个短而可爱的名字(如
Pikachu)更有用。
🛠 命名三步决策法 (Decision Matrix)
- 它是什么? (例:一个处理 JSON 的库)
- 它在哪里用? (例:在 Go 语言里作为中间件)
- 最终命名方案:
- 首选(工程级):
go-json-middleware - 次选(缩写级):
gjsm(需配合文档) - 拒绝(文青级):
Sparkle
- 首选(工程级):
记住: 命名不是创作短篇小说,命名是编写索引。Boring is Professional. (枯燥即专业)