代码整洁之道(整理一:变量)

背景:上班咸鱼的实在是太无聊了!!!我都咸鱼好多天了。。。把之间看的这本书的重点整理成文章吧!

一、整洁代码

1.1 代码乱的原因:
1、很多情况,敢工期,代码写的乱七八糟,特性越来越多,最后加上,开发人员的人员流动,代码几乎无法管理。(最近公司一个小医院的几年前的项目的支付功能,需要增加一个一键支付的功能:代码杂乱无章,没有代码风格,没有代码章法,由于之前支付出过各种问题,但后为了兼容这些问题,增加了大量的代码规避这些问题,然后落到我手上,这个代码几乎就根本无法维护了,导致这个一键支付的功能迟迟上不了线,被客户多次抱怨)

2、稍后等于不。(在上家公司,见过一个人写的代码,代码写的很乱,代码后面注释说:等以后有时间重构,结果,直到他离职,都没有重构。。。)

1.2 混乱的代码
项目初期会进展迅速,但是之后,会慢如蜗牛,每次修改都必须要对这些糟糕的代码的所有了然于心,否则几乎无法修改,而且,你也只能在一个废柴里扔更多的废柴,让其更加难以维护。

1.3 如何整洁的代码呢
1、应该尽可能始终保持代码的整洁。
2、写整洁的代码,需要遵循大量的小技巧。
3、很多人直到代码写的乱,但是又不知道如何优化。(我以前就很有这种感觉,明知道代码乱,但是很无力,不知道如何修改)
4、整洁的代码应该让人看起来,直到写这个代码的人对这个代码很在意,有一种在意感。
5、没有重复的代码。
6、尽可能少的实体:比如类、方法、函数等。
7、检查对象或方法是否做的事情过多,如果过多,最好切分为多个对象,如果方法功能太多,就抽取extract method重构,从而通过增加的这个方法的方法名,简单了解到整个大方法做了哪些事情。

二、有意义的变量名

  1. 命名是很严肃的事情,往往修改很多次都不为过,如今开发工具很先进,修改变量名的代价变得很低。
    2、选命名要花时间,但是省下来的时间比花掉的更多,而且一旦发现有更好的命名,就换掉旧的,这样做,读你代码的人会很开心。
    3、 代码的名字应该告诉你,它为什么存在、它做了什么事情、它应该怎么用,如果名称需要用注释来补充,那就不算名不副实。
    比如:名字可以长一点,比你短名但是描述不清楚你是谁更好。
    4、避免误导。变量的命名不能让人产生误导,不如,list会直接让人联想到这是list列表。比如两个变量名区分多不高,让人花时间区分两个变量名谁是谁上。
    5、相似的名称的方法可以放到一起,并且依据字母的顺序排序,这样,当我们通过开发工具,查看方法的时候,差异会很明显,而且不看注释,就知道应该调用哪个方法。
    6、变量名一定要有意义,不能因为变量名不能重名,就后缀1、2这种命名。
    7、废话都是冗余,比如:表的命名,一tb或者t等作为前缀,String类型的以string或者str作为后缀等,因为这都是废话。
    8、使用可搜索的名称。(这个看情况,如果本地变量大不必如此,很重要的controller方法,便于后期搜索你可以去一下区分度高的命名,便于后期搜索查询。)
    9、类名应该是名词,方法应该是动词。
    10、查询方法列表的时候,比如idea的f12,eclipse的ctrl+o,都不会把方法上的注释给你展示出来,所以方法的所有过于依靠注释,那么将很难寻找。
    11、不要添加没用的语境,比如,你的类名是address,然后这个类名下的所有方法都以address作为前缀,这完全没必要。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,287评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,346评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,277评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,132评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,147评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,106评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,019评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,862评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,301评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,521评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,682评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,405评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,996评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,651评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,803评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,674评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,563评论 2 352

推荐阅读更多精彩内容