Clean Code

2017-10-12  本文已影响0人  孤独的喵宝宝
      最近刚刚开始实习,然后第一天写了一天代码,晚上把代码拿给大佬看的时候,被疯狂diss,然后我也知道我代码写的很乱,其实可能就是因为我的编程习惯不好,拿到一个东西就应该思考,一定一定要先思考,但是我好多时候,一看到界面的时候,就很习惯的直接去写代码了,所有的代码就纯粹是为了完成任务的代码,没有一点可以利用的地方,昨天大佬丢了一本书给我,叫《clean code》,让我拿下去翻翻,不看不知道,一看是吓一跳,我的代码真的太乱了,而且有很多的重复代码,主要就是因为重复代码太多,然后看着头大,也不知道该从那看起,然后第二天差不多改了一天,然后将能封装的地方,都封起来,代码界面的公共区域,都封装成单个的uiview,然后其他特殊的视图就单独在添加,改了一天之后 我感觉我自己看起来顺眼多了,至少我看起来会顺眼太多,然后呢,就简单整理一下我之前看书的笔记,仅供个人参考

1.整洁代码
什么是整洁的代码呢,借用书里的原话
Ron Jeffries 对整洁代码的理解:

1.1.能通过所有的测试。

1.2没有重复代码。

1.3体现系统中的全部设计理念。

1.4包含尽量少的实体、比如类、方法、函数等。

2.轮子-> 处理重复代码,抽象代码
重复代码是最辣鸡的代码,没有之一,虽然很多重复代码你都是ctrl+c,Ctrl+V,就可能你是没有敲第二遍,但是呢,你的代码阅读的时候,是非常非常头大的,就有些代码你在即将要复制粘贴的时候,就要开始思考,能不能封装起来!
重复代码问题,如果一段代码被写了第二次,那么你就可以想想该干些什么了
2.命名
下面三个的命名是没有区别的,这种命名也毫无意义,
product,productInfo,productData ,
不要添加没有意义的前缀,添加有意义的语境
类名:名词或名词短语
方法名:动词或动词短语
像Customer,Account,避免使用Manager,Processor,Data或者Info这样的类名。类名不应当是动词。方法名应该是动词或动词短语,如postPayment ,deletePage或Save,属性访问、修改和断言应该根据其值来命名,并加上get,set,is这些前缀。
not add , use insert or update
命名方式保持一致
任何一个对象或者属性的命名都应该是有意义的,一旦有好的名字之后,最好就立马换掉
不要误导别人,比如一个属性不是list,就不要在名字里面添加list,

做有意的区分。

Public static void copyChars(chara1[],chara2[]){for(inti=0;i

a2[i]=a1[i];

} }

如果参数名称改为source和destination ,这个函数就会像样很多。废话都是冗余的,Variable一词 永远不应当出现在变量名中。Table一词永远不应当出现在表名中。NameString 会比 Name好吗,难道Name 会是一个浮点数不成?如有一个Customer的类,有又一个CustomerObject的类。是不是就凌乱了。

3.函数
将函数分解为更小更具体的函数
函数的第一规则是短小,第二规则是还要短小(20行的函数)
如果还是太长就应该使用类
函数应该只做一件事
函数的缩进层级不该多余一层或两层
自顶向下读代码
每个函数后面都跟着位于下一抽象层级的函数
无参函数>单参函数>双参函数>三参函数(尽量不用)
单参函数,两种输入类型,一种是操作该参数,二是转换该参数
stringBuffer transform(StringBuffer in)优于void transform(StringBuffer out)
函数一是做什么事,要么回答什么事

4.其他
抽离try/catch
抽象异常类
记得每天都review你的代码,然后有新的需要修改的地方就立即修改,later equals never,好的代码不是一次性就写出来的,是需要慢慢修改,写代码就和修剪树木是一样的,都是要慢慢修改之后,最好的永远是最新的,
注释不能美化糟糕的代码,如果你的函数命名需要注释来解释,那么就要想想,是不是应该给函数换一个名字
废话,日志,误导 注释,位置标记,这些注释都是毫无意义没卵用的注释,
空白行隔离代码

后面书剩下的地方还没看,看了之后会更新后面的笔记,未完待续·····

上一篇下一篇

猜你喜欢

热点阅读