重构读书笔记

本文是重构的读书笔记,强调了注释、变量、方法、类和接口的设计原则。建议尽量少写注释,选择清晰的变量名,保持方法短小且专注于单一职责,避免类成为大杂烩,保持接口简洁。同时,提倡用多态替换if和switch,避免方法级联调用,并使用枚举类代替常量。这些规则有助于提升代码的可读性和可维护性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

总结一下重构的读书笔记,一个个知识点总结

1   注释

   1   尽量少写注释,注释是用来弥补你代码表述的不足,注释越多,说明你的代码越不易理解

   2   用代码的清晰度来做注释,如果你的代码读起来让人感觉就跟看一行行清晰的注释,那你的可读性就非常高

   3  少写注释还有一个原因,就是注释可能一百年不会有人修改,而那个时候你的代码早已面目全非了,那个时候,注释无疑就是毒药

2  变量

    1.变量名一定要清晰,不要怕变量名很长,a b这样的变量名是很短,可谁知道它们的含义

    2  尽量少生成变量,很容易混淆

    3  变量要在使用的地方生成,如果你在第一行创建一个变量,然后在第一百行使用它,非疯了不可

3  方法

   1  写方法要有重用的思维在里面,否则会产生大量的重复代码,而重复是优秀代码最大的拦路虎

   2 方法的长度一定要简短,有好多的标准,但个人觉得30行代码最多,这样处理问题,看代码会很方便

   3  一个方法最好只做一件事,这也符合单一职责原则,最忌讳的是,一个方法里面既有查询,又有修改

   4 方法名一定要表述清楚,不要怕方法的实现会比方法名短,要知道,好的方法名会让后期的开发维护人员节省好多成本

4  类

   1 一个类最好只做自己分内的事,如果有别的事情放进来,坏味道就会出去,破窗效应就会显现,慢慢的,你会发现自己的类成了大杂烩,已经远远脱离了最初设计时的初衷

    2  如果多各类有相同的东西,提取出来,构建超类,这样不仅减少了代码量,也是每个类专心做自己分内的事情

    3 如果超类中的方法或者变量很少被用到,销毁超类,然后将它的成员下放到子类中

    4 如果一个类过于庞大,按照业务不同拆解它,这样就不必在系统中到处拖着这个庞然大物行走

5  接口 

    1 定义好接口名很重要,因为它是我们对外交流的桥梁

    2  接口中不要做分外的事情 ,要保持接口的清爽,如果有其他类型事情要做,定义新的接口

6 写代码

   1.if 和switch尽量用多态代替

   2 不要让方法级联调用,如a.b.c,这样a就会知道b和c有关系,一个方法最好不要知道其他方法的东西

   3  代码的实现最好在一个层级上,不要让业务上有上下级关系的代码处于同一层级,这样容易让人混淆业务关系

   4 所有的访问调用,如果可以,创建包装方法,这样在以后的修改中不必修改调用方,当然,如果调用比较少,直接调用也没有问题

   5  尽量不要返回错误状态吗,而去封装自己的异常

   6 尽量使用枚举类,不要使用常量类、或者在接口中写一大堆常量这种方式


这只是基本的准则,实际实现时,要灵活运用,只是大部分情况下以上规则是适用的。先总结这些,以后想起来再写吧!


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值