命名准则
- 变量名要完全,准确的描述变量所代表的事物,一般而言,对变量的描述就是最佳的变量名。避免x,temp,i等泛泛而谈的变量名。
- 比如对于矩阵的循环,matrix[row][col]就比m[i][j]好很多。
- 当变量名过长时,进行适当的缩写。(去掉介词等)
- numberOfPeopleOnTheUsOlympicTeam->numTeamMembers。
- numbofOfSeatsInTheStadium->numSeatsInStadium。
- maximumNumberOfPointsInModernOlympics->maxPoints
- 当变量名取的很短时候(比如i),通常说明这是一个普通的循环计数器或者数组下标,在这几行代码以外它没有任何作用。
- 对于表示计算结果的限定词(比如总额sum,平均值avg,最大值max,最小值min等)需要放在最后
- revenueTotal
- expenseAverage
- customerCount
- customerIndex
- 给循环下标命名
for(int teamIndex=0;teamIndex<teamCount;teamIndex++){ for(int eventIndex=0;eventIndex<eventCount;eventIndex++){ score[teamIndex][eventIndex]=0; } }
- 给状态变量命名时不要出现flag,也不要出现is,if(isFound)可读性没有if(found)可读性好;
- 注意一些常见的布尔变量(二值状态变量)的命名(done——某事情做完了,error——发生错误,found——某值找到了)
// 状态变量二值时,用boolean类型表征 if(dataReady) ...... if(found) ...... // 状态变量多值时用枚举类型表征 enum Weekday{ SUN,MON,TUE,WED,THR,FRI,SAT; } public class mySolution { Weekday today=Weekday.WED; if(today!=Weekday.WED) ....... }
- 给临时变量起名
public void exchange(int[] array,int index,int anotherIndex) { int valueCopy=array[index]; array[index]=array[anotherIndex]; array[anotherIndex]=valueCopy; }
Java命名规则
- 类名首字母大写,Student
- 枚举类型首字母大写且使用复数形式,枚举元素全部大写并用下划线分割,enum Colors{RED,BULU...}
- 局部变量首字母小写 Student studentInCS
- 类方法首字母小写 bool hasMoreValues(...){...}