变量（函数）命名最佳实践

良好命名的必要

1. 代码命名是件很头疼的事情，既要语义化又要简洁，最终目的为了代码的可维护性
2. 合适的命名会使代码读起来优雅流畅、耐人寻味，让你的代码如艺术品一般。比如：
   • promise - 异步请求数据时，“承诺”一定会回应（成功或失败），很有画面感
   • on/off - jquery 中表示监听和销毁事件，言简意赅，方便易用
   • fork - github 的 fork 操作，由“叉子”引申为复刻属于自己的分叉，形象生动

良好命名的要点

1. 使用能够表达意图的名字

   良好命名能够告诉我们它要做什么，为什么存在，以及是如何工作的。选择能够表达意图的名字，有利于我们清楚理解程序含义。相反，名不副实则会误导阅读代码的人，有时需要打断点才能判断出程序的真实功能。

2. 不要怕在选择名字上花时间

   多尝试几种不同的名字，直到足以描述程序含义，不要害怕在命名上花时间。以后阅读你代码的人（包括自己）会因此受益。而且，一个具有清晰描述性的命名，还有助于你在心中理清模块的设计。良好的命名可能需要花费额外的时间，但是从长远来看，利大于弊。

3. 类名

   类名应该是个名词或名词词组，如 Customer、Account、AddressParser。父类的命名应该简短，子类的应该详尽，通过形容词来描述其不同于父类之处，如 SavingsAccount 继承自 Account。

4. 变量名

   变量名一般应该是名词。如果是布尔变量，应写成谓词的形式，如 isEmpty，这样放到if 语句才便于理解。

5. 方法名

   方法名应该是一个动词或动词词组，如 sendMessage()、getUser()、save()。访问器和设置器应该分别带有 get 和 set 前缀。返回布尔值的方法应该前缀 is，如 isPostable()。

常用动词、对仗词

常用名词

常用缩写

建议在 css 中命名多用缩写，在 js 中根据实际场景选择是否使用

常用前缀

常用后缀

布局相关

组件相关

参考文章

awesome-name

每个程序员需掌握的20个代码命名小贴士

计算机变量命名常用词汇包括对仗词