读代码时,最消耗注意力的往往不是语法,而是猜测:这个值是什么?单位是什么?这个函数会不会改变输入?名字越准确,读者需要在脑子里保存的上下文就越少。
把含义和单位写出来
在短小的计算里,简短名字未必有问题。但当一个值要跨越多个函数时,用具体的名字往往更划算。例如,把等待时间写成 delayMs,把条目数量写成 itemCount,可以少一次对单位和含义的猜测。
const delayMs = 300;
const hasVisibleItems = visibleItems.length > 0;
function getPublishedNotes(notes) {
return notes.filter(note => note.published);
}
让动作与结果一致
以 get 开头的函数通常让人期待读取结果。如果函数还会保存文件或修改共享状态,就应该在命名或接口说明里明确体现。名字形成的预期,最好与实际行为保持一致。
遵循项目里已有的表达
同一个概念不要在不同文件里反复换词。先看项目中已有的叫法,再决定新名字。团队能一致理解的表达,比一个孤立但精巧的名字更有价值。
需要注释解释的,常常是“为什么这样做”;代码本身则尽量说清楚“正在做什么”。