提出问题

如何在编程中给变量,函数,类等等取个好名字???
简书地址:http://www.jianshu.com/users/d38a3668be58/latest_articles

解决问题

好的名字相当于为代码写了一段有用的注释,

1)不要使用有误导性的字母作为变量名,比如小写字母l和大写字母O,因为他们和数字的1和0很像(老话题了);

2)不要使用单个字母来做变量名,时间一长,自己都不清楚自己当初的命名是什么意思。(小方法体,如循环中的计数器除外);

3)类名和对象名一般都是名词和名词短语,而不应当使用动词;

4)方法名一般是动词和动词短语;get,set,is前缀;

  1. public void getUsers();
  2. public void getData();
  3. public void isCompleted();

5)不必使用带类型的匈牙利标记法,Java使用Camel风格;

6)对于方法名应该保持一致,比如对于绑定数据的方法,不要有的地方用BindData,而另一些地方使用DataBind ;

7)避免误导:userList的类型最好就是List;

  1. //错误
  2. String userList = "";
  3. //正确
  4. List<String> userLit = new ArrayList<>();

8)使用可搜索的名称:避免使用单字母变量和数字常量;

//错误
int s = 0;
for(int i=0;i<100;i++){
   s = s + i;
}
//正确,起码sum在搜索时比较方便
int sum = 0;
for(int i=0;i<100;i++){
   sum = sum + i;
}

9)添加有意义的语境:使用有意义的前缀,创建一个类并将变量声明为成员变量;

String addrFirstName;
String addrLastName;
String addrState;
//这里的addr就是有意义的前缀,代表的是地址

10)命名要精确:不要添加无意义的语境;