代码整洁之道

前言:所谓书读百遍,其意自现。今天来重温一下代码整洁之道这本书,看是否有新的体会。

第2章 有意义的命名

1、名副其实

为变量、类、函数选个好的名字,的确很花时间。但一个好的名字省下来的时间比花的多。名字所传递出来的信息,告诉着你,它为什么存在,它做了什么事,应该如何使用。那么这里需要注意的是,如果变量、类、函数需要注释来补充,那也不算名副其实。

2、避免误导

错误示例

int O = 0;
int l = 1;
int a = l;
3、做有意义的区分

错误示例

public static void copyChars(Char a1[], Char a2[]) {}
ProductInfo、ProductData
int numberVariable;
String nameString;
BigDecimal moneyAmount;
tb_user

第二章总结一下,类和对象指的是一类事物,对其命名也应该是名词,方法是动作,应该是动词。好的命名对程序的可读性还是非常有帮助的。


第3章 函数

1、短小

写函数的第一条规则是短小,第二条规则是还要更短小。个人经验啊,一个方法最好不要超过50行,所以方法还是要分层的,分层的话,意思明了,结构清晰,往后的维护的人没有那么痛苦。

2、只做一件事

一个方法要不要分层,能不能分层,怎么样去分层的评判规则就是这个方法是否只做了这一件事情,并且把这件事给做好了。

3、函数参数

错误示例

public void checkCreateMerchant(
  String merchantId, 
  String merchantName, 
  String merchantAddress, 
  String merchantEmail) {
}

Java是面向对象编程的语言,希望大家不要面向参数编程。方法两个参数就行了,超过了的方法参数,还是写个参数类吧。

4、try/catch

说实话try/catch好丑啊,try/catch跟业务半毛钱关系没有,就不应该放到controller层。但之前项目都是这样做的,就很烦。try/catch放到AOP处理,controller层多简洁漂亮,还节约开发时间。


第4章 注释

1、写注释是一种失败

写注释是一种失败,因为你的代码很糟糕,没有表达力,所以要写注释来解释你的代码,听懂掌声。说实话作者就被注释骗过,太坑了,只有代码才能表达真正的意思。这是因为后来维护代码的人改了代码之后不一定会改注释的。耶,就很烦。所以只有代码才是唯一准确的信息来源。

2、好的注释

正确示例

//  sourceNumber > targetNumber  阐述注释
if (sourceNumber.compareTo(targetNumber) == 1) {
    // TODO 注释
}

第4章总结,能用变量名、方法名解释就不要用注释。


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

推荐阅读更多精彩内容