有意义的命名

名副其实

变量名应该告诉你:他为什么会存在,他做什么事,他应该怎么用

如果名称需要注释来补充,那就不算名副其实

public List<int []> getThem() { List<int[]> list1 = new ArrayList<int[]>(); for (int[] x:theList) { if (x[0] == 4) { list1.add(x); } } return list1; }
代码整洁但是模糊,无法通过上下文阅读获取变量的意义
public List[Cell] getFlaggedCells() { List<Cell> flaggedCells = new ArrayList<Cell>(); for (Cell cell : gameBoard) if (cell.isFlagged()) flaggedCells.add(cell); return flaggedCells; }
修改项

  • 给固定状态特殊赋值,加强逻辑意义
  • 去掉list等无业务属性的变量名,改用flaggedList充满了业务属性啊
    <strong>总结一点</strong> :变量的来源,尽可能描述清楚变量的业务意义

避免误导

1 不要使用系统自带的变量名,系统的专用名来命名:hp,aix,sco等
2 不要使用程序语言的数据类型来做变量名的组成部分:accountList,如果这个变量不是个list岂不是雪崩,可以用group,bunchof,加s来代替
3 不要让变量名之间仅有细微的差别,鬼才看得出来
4 最可怕的,不要在变量名中出现小写的l,大写的O,鬼知道是l还是1,是O还是0


做有意义的区分

如果程序员只是为了满足编译器或者解释器的需求写代码,就会制造麻烦。

  • 同一范围内两样不同的东西不能重名
  • 废话是另一种没意义的区分 ProductData
  • 冗余废话 NameString, CustomerObject
  • 数字系列命名是意义命名的对立面a1,a2

最终一点命名要提现意义要有所区分,要区分名称,就要以<strong>读者</strong>能鉴别不同之处的方式来区分


使用可搜索的名称

单字母名称和数字敞亮有个问题,就是很难再一大片文字中找出来
名称长短应与其作用于大小相对应


避免使用编码

编码已经太多,无畏自找麻烦
一句话总结:不要要把代码的逻辑扔到变量命名中,变量命名的唯一目的是描述业务,加强业务可读性。

  • 匈牙利标记法(不要把变量属性扔进变量名)
  • 成员前缀(不要加奇怪的前缀做某种类型的成员表示= =有这能耐不如把代码拆小点,尽量让变量的作用在视野范围内)
  • 接口类型也不要特殊表示= =(用的不多)

避免思维映射

明确是王道


类名

类名和对象名应该是名词或名词短语


方法名

方法名应该是动词或者动词短语
重载构造器时,使用描述了参数的静态工厂方法名。for 1个sanple:
Complex fulcrumPoint = Complex.FromRealNumber(23.0);
要好于
Complex fulcrumPoint = new Complex(23.0);
FromRealNumber声明成Complex的静态工厂方法,甚至还可以把构造函数声明成private,只能通过工厂方法获取对象


别扮可爱

= =顾名思义 不要有情绪化的 卖萌的命名

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

推荐阅读更多精彩内容