优雅的命名

代码中随处可见我们的命名:变量、函数、类、包等,我们无时无刻不在命名和使用自己命名。优雅的命名必须满足一下要求。

1.自解释的命名,不需要注释就能看懂

2.拒绝类似具有误导性的命名

3.拒绝没有意义的命名(例如: a1,a2; aName, theName; customer, customerInfo; account, accountData 这些命名都是无意义的,无法区分的命名)

4.使用朗朗上口、可读性强的单词或词组,再不济也要用拼音,不能自造词(例如:genrationymdhms 就没有 generationTimestamp好)

5.使用能够搜索的名称,拒绝使用单字母命名、数字常量硬编码,单字母可能在代码中出现很多次,难以确定你要求的代码,数字常量硬编码和单字母一样难以搜索,

  就算拉长数字位数,如果其他人修改了,也难以找到。一般要通过定义常量或变量标识符标识字面量

6.类名、对象名和变量名一般使用名词或名词短语;方法名一般使用动词后动词短语。

7.每个概念都选择一个词,不要采用多种形式表达(例如:get,fetch,retrieve 都能表是获得,只需要选择一个用在程序中,拒绝在程序中使用多种表示方法)

8.命名要精确不要拖泥带水(例如:项目名叫ABC,项目中的所有类都命名为ABC开头的,这种做法是有问题的,因为如果我们去搜索ABC,会出现很多的条目,会让你感到疲倦)

 

每个人都要学会养成优雅命名的规范,使自己形成习惯,这样以后开发中就可以避免很多不必要的问题。

原文地址:https://www.cnblogs.com/glsy/p/8393366.html