外表或举止上令人愉悦的优美和雅观;令人愉悦的精致和简单是为“优雅”。
1、目的是为了更容易的理解名称的意义。
问题在于能不能第一时间确认这个名称代表什么。如果不能就要花时间去确认这名称的意义,并且如果参数很多的话不是很容易记住参数的意义,所以代码读起来就会比较困难的 搞清楚具体做了什么内容。
2、名副其实
如果名称需要注释来补充,那就不算名副其实(注释也很重要)。
例1:
错误实例:
int d;//消逝的时间,以日计
名称d并没有说明。没有真正的表现出消逝的时间并且以日计量。
修改:
int elapsedTimeInDays; //elapsed:(时间)消逝,流逝,elapse的过去分词和过去式
int daysSinceCreation;//翻译:创建后的天数
int daysSinceModification;//翻译:修改后的天数
int fileAgeInDays;//翻译:文件期限(天)
修改后,体现本意的名称让人更容易理解和修改代码。
例2:
尝试理解下面代码。
public List<int[]> getThem(){
List<int[]> list1 = new ArrayList<int[]>();
for(int[] x : theList)
if(x[0] == 4)
list1.add(x);
return list1;
}
思考:
1.theList中的元素是什么?
2.theList零下标条目的的意义是什么?
3.值4的意义是什么?
4.我们怎么搞使用返回的列表?
问题在于这段代码没有明确到底要做什么。比如,我们开发一个扫雷游戏。那theList改为gameBoard(游戏板),将int[]类型替换为Cell,Cell中包含横纵坐标,该类包含一个返单是否为4的函数isFlagged。
public List<Cell> getFlaggedCells(){
List<Cell> flaggedCells = new ArrayList();
for(Cell cell: gameBoard)
if(cell.isFlagged())
flaggedCells .add(cell);
return flaggedCells ;
}
基本可以读懂是什么业务。
3、避免误导
例1:别用List
别用accountList来指称一组账号,可以用accountGroup或bunchOfAccounts,还可以用accounts。因为List对程序员有特殊意义。
例2:避免形似。
XYZControllerForEfficientHandlingOfStrings和XYZControllerForEfficientStorageOfStrings。太像了,不好区分。
例3:1和l、0和O不要单独用:01、O1、0l、OL。很像。
int a = l;
if(O==l)
a = O1;
else
l = 01;
这都是什么玩意。
4、做有意义的区分
例1:别用数字系列命名
public static void cooyChars(char a1[],char a2[]){
for(int i=0;i < a1.length;i++){
a2[i] = a1[i];
}
}
可以将a1、a2换成source和destination,就目的明确了。
例2:别用废话区分
假设Product类。如果还有一个ProductData和ProductInfo;
getActiveAccount();getActiveAccounts();getActiveAccountInfo();
moneyAmount和money,theMessage和message。
都是名不同意相同,不看注释不知道有什么区别。
5、使用读得出来的名称
例1:尽量别用缩写,因为需要猜,并且不好交流
class DtaRcrd102{
private Date genymdhms;
private Date modymdhms;
private final String pszqint = "102";
}
和
class Customer{
private Date generationTimeStamp;
private Date modificationTimeStamp;
private final String recordId = "102";
}
6、使用可搜索的名称
名称长短应与其作用域大小相对应。
例:7不好搜索,但是命名成MAX_CLASSES_PER_STUDENT就容易全局搜索得到。
7、避免使用编码
例1:名称不要加类型
PhoneNumber phoneString;//类型变化时,名称并不跟着变化。
例2:不必用m_前缀来标明成员变量。
例3:可以用在类名后面加Imp来表示是接口需要实现
8、避免四位映射
明确才是王道
9、类名
类名 应该是名词或者名词短语,避免使用Manager、Processor、Data、Info这月的雷鸣
10、方法名
方法名应当是动词或者动词短语,属性访问器、修改器和断言应该根据其值命名。
重载构造器时,使用描述了参数的静态工厂方法名。
11、别扮可爱
12、每个概念对应一个词
13、别用双关语
14、使用解决方案领域名称
可以使用计算机科学术语、算法名、模式名、数学术语描述。
15、使用源自所涉及问题领域名称
可以采用从所涉及问题领域而来的名称
16、添加有意义的语境
17、不要添加没有用的语境
18、总结
言简意赅,明确的表达含义而不与其他名称混淆