烂代码吐槽汇 | 奇葩命名

代码首先是给人看的,其次才是给机器看的。 烂代码特征:可读性差、逻辑混乱、性能低下。


1.奇葩项目(模块)名

项目(模块)名称使用汉语拼音、英汉双拼、超长的字母集。

项目(模块)名称应该使用言简意赅的英文单词或短语,可代表项目(模块)意图即可。

2.奇葩包名

包名称使用毫无意义的单个字母或另类的单词。

正常的包结构名称应该以官网或产品域名的倒序为基础包,然后细分service、dao等。基本上常用的包名也就那几个,没必要为了体现出自己的不同而新创包名,如果真的有必要建新包名,应该使用名词性质的单词。

3.奇葩接口名

接口名命名规则不统一,千奇百怪,使用非名词性单词。

一般情况下,根据团队编码习惯,接口名称规则需要统一。最好不要使用以字母I为前缀或以interface为后缀,你不觉得这样很多此一举吗?名称命名需要使用名词性的单词或短语。

4.奇葩类名和对象名

类名或对象名使用动词,使用非名词或非名词短语。

类名和对象名是一个标识,所以不要使用动词,应该使用名词或名词性的短语,而且最好不要使用以Data和Info为后缀,这样的后缀给人感觉很累赘。

5.奇葩属性名

类的属性名为了和表的字段名称一致,名称中的单词使用下划线连接;属性名使用非驼峰式命名;使用无意义的字母或单词缩写。

类的属性名应该使用有意义的名词或名词性的短语,名称的首字母要小写,名称中包含多个单词的需要使用驼峰式的命名规则,一定不要使用无明确意义的字母或单词缩写。如果为了表达多个数据的集合,避免使用List结尾,可以使用对应单词的复数形式,如students,而不是studentList。推荐使用一些可读的出来或可搜索到的单词或短语,易于理解。对于一些boolean类型的属性名,推荐在名称前加上is前缀,这样容易理解其值的含义。

6.奇葩方法名

方法名以非动词开头;方法名不能表达出方法体的意图;方法名使用以get为前缀;方法名使用单词或短语的字母缩写;方法名不遵循驼峰式命名规则。

方法名应该以动词开头,使用动词短语;动词短语应该可以表达出本方法体的意图,做到可以根据方法名看出方法做了什么;除了属性的getter方法,避免使用以get作为方法名的前缀,因为get无法说清方法的意图,有偷懒的嫌疑,而且这样命名说明写代码的人真的很low;最不能忍的是方法名使用单词的字母缩写,谁能知道这是干啥的,就是代码作者自己,一段时间后也不能保证记得这是作什么的;方法名应该遵循首字母小写的驼峰式命名规则;对于返回值类型为布尔值类型的方法,推荐方法名前缀使用is、has、can。

7.奇葩变量名

变量名使用单个字母。

除了用于循环的临时变量名,其它变量都不要使用单个字母命名,且变量名要能表达出其真正意图,遵循驼峰式命名规则。

8.奇葩常量名

常量名使用非大写的单词或短语;常量名中的多个单词间不使用下划线连接。

常量名应该全部使用大写的字母,而且单词与单词间使用下划线连接。对于方法里用于比较或计算的“0”、“1”之类的常量,最好定义成常量,使用常量名标识这些数据的意思,否则谁能理解“0”代表什么,“1”代表什么。

小结

命名可以通过总结的方式,归纳出属于自己的一套命名规则。

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

推荐阅读更多精彩内容

  • 1、引言 数据库设计过程中表、字段等的命名规范也算是设计规范的一部分,不过设计规范更多的是为了确保数据库设计的合理...
    SnowflakeCloud阅读 40,937评论 0 48
  • 1.Resource文件 命名 遵循前缀表明类型的习惯,形如type_foo_bar.xml。如:fragment...
    Rave_Tian阅读 4,340评论 0 1
  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 930评论 0 0
  • [TOC] 前言 这份文档是Google Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的...
    marine8888阅读 1,940评论 0 1
  • Cocoa代码风格指南之命名规范(一) Cocoa代码风格指南之排版规范(二) Cocoa代码风格指南之注释规范(...
    xuyafei86阅读 3,349评论 0 8