代码整洁之道--有意义的命名

外表或举止上令人愉悦的优美和雅观;令人愉悦的精致和简单是为“优雅”。

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、总结

言简意赅,明确的表达含义而不与其他名称混淆

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,718评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,683评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,207评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,755评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,862评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,050评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,136评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,882评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,330评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,651评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,789评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,477评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,135评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,864评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,099评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,598评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,697评论 2 351

推荐阅读更多精彩内容