编写让别人能够读懂的代码
随着软件行业的不断发展,历史遗留的程序越来越多,代码的维护成本越来越大,甚至大于开发成本。而新功能的开发又常常依赖于旧代码,阅读旧代码所花费的时间几乎要大于写新功能的时间。
我前几天看了一本书,书中有这么一句话:
“复杂的代码往往都是新手所写,只有经验老道的高手才能写出简单,富有表现力的代码”
此话虽然说的有点夸张,可是也说明了经验和智慧的的重要性。
我们所写的代码主要是为了阅读,其次才是被机器执行。所以我们要写:
- 让别人能读懂的代码
- 可扩展的代码
- 可测试的代码(代码应该具备可测试性,对没有可测试性的代码写测试,是浪费生命的表现)
其中2,3点更多强调的是面向对象的设计原则。而本文则更多关注于局部的代码问题,本文通过举例的方式,总结平时常犯的错误和优化方式。
本文的例子基于两个指导原则:
一.DRY(Don't repeat yourself)
此原则如此重要,简单来说是因为:
- 代码越少,Bug也越少
- 没有重复逻辑的代码更易于维护,当你修复了一个bug,如果相同的逻辑还出现在另外一个地方,而你没意识到,你有没有觉得自己很冤?
二.TED原则
- 简洁(Terse)
- 具有表达力(Expressive)
- 只做一件事(Do one thing)
三.举例说明
1.拒绝注释,用代码来阐述注释
反例:
/// <summary>/// !@#$%^&^&*((!@#$%^&^&*((!@#$%^&^&*((!@#$%^&^&*((/// </summary>/// <returns></returns>public decimal GetCash(){//!@#$%^&^&*((!@#$%^&^&*((var a = new List<int>() { 2, 3, 10 };var b = 2m;var c = 0m;//!@#$%^&^&*((!@#$%^&^&*((!@#$%^&^&*((foreach (var p in a){c += p*b;}return c;}
重构后:
public decimal CalculateTotalCash(){var itemCounts=new List<int>(){2,3,10};var price = 2m;return itemCounts.Sum(p => p*price );}
良好的代码命名完全可以替代注释的作用,如果你正在试图写一段注释,从某种角度来看,你正在试图写一段别人无法理解的代码。
当你无法为你的方法起一个准确的名称时,很可能你的方法不止做了一件事,违反了(Do one thing)。特别是你想在方法名中加入:And,Or,If等词时
2. 为布尔变量赋值
反例:
public bool IsAdult(int age){bool isAdult;if (age > 18){isAdult = true;}else{isAdult = false;}return isAdult;}
重构后:
public bool IsAdult(int age){var isAdult = age > 18;return isAdult;}
3.双重否定的条件判断
反例:
if (!isNotRemeberMe)
{}
重构后:
if (isRemeberMe)
{}
不管你有没有见过这样的条件,反正我见过。见到这样的条件判断,我顿时就晕了。
4.拒绝HardCode,拒绝挖坑
反例:
if (carName == "Nissan"){}
重构后:
if (car == Car.Nissan)
{}
既然咱们玩的是强类型语言,咱就用上编译器的功能,让错误发生在编译阶段
5.拒绝魔数,拒绝挖坑
反例:
if (age > 18)
{}
重构后:
const int adultAge = 18;if (age > adultAge)
{}
所谓魔数(Magic number)就是一个魔法数字,读者完全弄不明白你这个数字是什么,这样的代码平时见的多了
6.复杂的条件判断
反例:
if (job.JobState == JobState.New|| job.JobState == JobState.Submitted|| job.JobState == JobState.Expired|| job.JobTitle.IsNullOrWhiteSpace()){//....}
重构后:
if (CanBeDeleted(job)){//} private bool CanBeDeleted(Job job){var invalidJobState = job.JobState == JobState.New|| job.JobState == JobState.Submitted|| job.JobState == JobState.Expired;var invalidJob = string.IsNullOrEmpty(job.JobTitle);return invalidJobState || invalidJob;}
有没有豁然开朗的赶脚?
7.嵌套判断
反例:
var isValid = false;if (!string.IsNullOrEmpty(user.UserName)){if (!string.IsNullOrEmpty(user.Password)){if (!string.IsNullOrEmpty(user.Email)){isValid = true;}}}return isValid;
重构后:
if (string.IsNullOrEmpty(user.UserName)) return false;
if (string.IsNullOrEmpty(user.Password)) return false;
if (string.IsNullOrEmpty(user.Email)) return false;return true;
第一种代码是受到早期的某些思想:使用一个变量来存储返回结果。事实证明,你一旦知道了结果就应该尽早返回。
8.使用前置条件
反例:
if (!string.IsNullOrEmpty(userName)){if (!string.IsNullOrEmpty(password)){//register}else{throw new ArgumentException("user password can not be empty");}}else{throw new ArgumentException("user name can not be empty");}
重构后:
if (string.IsNullOrEmpty(userName)) throw new ArgumentException("user name can not be empty");if (string.IsNullOrEmpty(password)) throw new ArgumentException("user password can not be empty");//register
重构后的风格更接近契约编程,首先要满足前置条件,否则免谈。
9.参数过多,超过3个
反例:
public void RegisterUser(string userName, string password, string email, string phone){}
重构后:
public void RegisterUser(User user){}
过多的参数让读者难以抓住代码的意图,同时过多的参数将会影响方法的稳定性。另外也预示着参数应该聚合为一个Model
10.方法签名中含有布尔参数
反例:
public void RegisterUser(User user, bool sendEmail){}
重构后:
public void RegisterUser(User user){}public void SendEmail(User user){}
布尔参数在告诉方法不止做一件事,违反了Do one thing
10.写具有表达力的代码
反例:
private string CombineTechnicalBookNameOfAuthor(List<Book> books, string author){var filterBooks = new List<Book>();foreach (var book in books){if (book.Category == BookCategory.Technical && book.Author == author){filterBooks.Add(book);}}var name = "";foreach (var book in filterBooks){name += book.Name + "|";}return name;}
重构后:
private string CombineTechnicalBookNameOfAuthor(List<Book> books, string author){var combinedName = books.Where(b => b.Category == BookCategory.Technical).Where(b => b.Author == author).Select(b => b.Name).Aggregate((a, b) => a + "|" + b);return combinedName;}
相对于命令式代码,声明性代码更加具有表达力,也更简洁。这也是函数式编程为什么越来越火的原因之一。
四.关于DRY
平时大家重构代码,一个重要的思想就是DRY。我要分享一个DRY的反例:
项目在架构过程中会有各种各样的MODEL层,例如:DomainModel,ViewModel,DTO。很多时候这几个Model里的字段大部分是相同的,于是有人就会想到DRY原则,干脆直接用一种类型,省得粘贴复制,来回转换。
这个反例失败的根本原因在于:这几种Model职责各不相同,虽然大部分情况下内容会有重复,但是他们担当着各种不同的角色。
考虑这种场景: DomainModel有一个字段DateTime Birthday{get;set;},ViewModel同样具有DateTime Birthday{get;set;}。需求升级:要求界面不再显示生日,只需要显示是否成年。我们只需要在ViewModel中添加一个Bool IsAdult{get{return ....}}即可,DomainModel完全不用变化。
五.利用先进的生产工具
以vs插件中的Reshaper为例,本文列举的大部分反例,Reshaprer均能给予不同程度的提示。经过一段时间的练习,当Reshaper对你的代码给予不了任何提示的时候,你的代码会有一个明显的提高。
截图说明Reshaper的提示功能:
光标移动在波浪线处,然后Alt+Enter,Resharper 会自动对代码进行优化
如果你能够避免本文总结的反例,你的代码就已经具备了优秀代码应有的基因。当然高质量的代码还需要良好的设计和遵循面向对象编程的原则。 如果想了解更多相关内容,请阅读《代码大全》,《代码整洁之道》,《重构 改善既有代码的设计》,《敏捷软件开发 原则、模式与实践》
追加:既然大家对拒绝注释这个建议觉得不可行,我拿出来详细说说: 1.如果你的团队代码命名不错,代码写的还算不错,没有一些奇怪的实现方式,不妨可以尝试去掉注释试试效果。因为写注释需要成本,并且重构代码的时候往往会忽略注释的修改,时间长了注释也不够准确,反而成了一种累赘。 2.如果你的团队代码写的丑陋不堪,命名也不规范,注释必须要有,注释再不准确也比读代码读着强些。
转载于:https://www.cnblogs.com/richieyang/p/4840614.html
编写让别人能够读懂的代码相关推荐
- 如何编写让别人能读懂的代码?
随着软件行业的不断发展,历史遗留的程序越来越多,代码的维护成本越来越大,甚至大于开发成本.而新功能的开发又常常依赖于旧代码,阅读旧代码所花费的时间几乎要大于写新功能的代码. 我前几天看了一本书,书中有 ...
- 写让别人能读懂的代码
随着软件行业的不断发展,历史遗留的程序越来越多,代码的维护成本越来越大,甚至大于开发成本.而新功能的开发又常常依赖于旧代码,阅读旧代码所花费的时间几乎要大于写新功能的代码. 我前几天看了一本书,书中有 ...
- 如何快速读懂开源代码?
文章目录 **RUN起来** **调试** **把控关键数据结构和函数** **从小的开始** **关注一个模块** **工具** **一.阅读开源代码存在的一些误区** 二.阅读代码的心态 **三. ...
- 读懂python代码_读懂花里胡哨的14行Python代码!
最近在项目里发现一段代码,初看比较难看懂,细看,也还是比较难看懂.遂研究了一下,证实了这段代码确实,没啥作用,遂删之.记录在下. 去掉几个用于封装的函数,保留最小代码后,剩下以下14行代码.你能说出这 ...
- 如何快速理解读懂他人代码(下)——技巧学习篇
四.望文生义,进而推敲组件的作用 先建立系统的架构性认识,然后透过名称及命名惯例,就可以推测出各组件的作用.例如:当Winamp尝试着初始化一个Plug-In时,它会呼叫这个结构 中的init函式,以 ...
- 一文读懂恶意代码中病毒、蠕虫、木马和逻辑炸弹的区别
病毒.蠕虫.木马和逻辑炸弹的区别 病毒:破坏计算机功能或数据,以破坏为主,传染其他程序的方式是通过修改其他程序来把自身或其变种复制进去完成的,典型的熊猫烧香 蠕虫:通过网络的通信功能将自身从一个结点发 ...
- 如何读懂python代码_教你如何阅读 Python 开源项目代码
作者: Destiny 来源:https://learnku.com/articles/23010/teach-you-to-read-the-python-open-source-project-c ...
- 计算机内部程序代码,计算机为什么能够读懂程序代码?
01 引子 上一回,我们的主人公小A初次亮相,凭借基础的前后端理解,从技术实现的层面为我们剖析了微信扫码登录的原理和机制.可能很多人因此会好奇,小A到底是做什么的呢?为什么能够弄懂这些原理呢? 其实, ...
- java中this_夯实Java基础系列7:一文读懂Java 代码块和执行顺序
目录 #java中的构造方法 #构造方法简介 #构造方法实例 #例-1 #例-2 #java中的几种构造方法详解 #普通构造方法 #默认构造方法 #重载构造方法 #java子类构造方法调用父类构造方法 ...
最新文章
- ACCESS数据库防止下载
- Java面向对象(9)--方法的重写(override/overwrite)
- 【 Grey Hack 】万金油脚本:常见端口修改Password
- iPhone 14进入代工试产阶段:首款打孔屏iPhone要来了
- python集合运算_python 集合(set)
- linux服务器运维操作命令,Linux服务器运维常用命令列表
- Kettle增量同步变动数据
- 用python实现搜索树_二叉搜索树的python实现
- c#明华rf读卡器_RF通用开发包 明华RF读卡器 demo for c#(RF reader demo for c#) - 下载 - 搜珍网...
- 1-7 华为HCNA认证eNSP基础A
- (四)JSP语法详细介绍--脚本元素
- POI导出Excel时 设置单元格类型为 数值类型 或者文本类型
- 31岁,断奶两年,我与乳腺癌擦肩而过
- 使用keytool转换签名证书格式,keyStore、jks签名证书相互转换
- MIMO技术与链路容量
- C语言统计元音字母数量
- Len()、Lenw()与Lenb()函数间的区别
- mongodb针对查询数据保留两位小数或者自定义
- 带时间轴的文章归档的html页面,WordPress纯CSS打造时间轴归档页面
- 想参加IT培训,了解到达内、蜗牛学院、优就业、黑马、善知教育等机构,哪家比较好?