章
目
录
如何写出高质量、易维护的代码呢?《代码整洁之道》给出了答案。这本书由人民邮电出版社出版,是异步图书原版系列之一,作者是Object Mentor公司总裁Robert C. Martin。他在面向对象设计、敏捷方法学等领域都是资深顾问,还著有不少畅销书。这本书在豆瓣上收获了9.1分的高分,深受读者认可。文末会给朋友们提供该电子书文档免费下载地址,不要错过哦。
一、核心观点与实用规则
书中提出一个关键观念:代码质量和整洁度成正比。干净的代码不仅质量可靠,还为后续的维护和升级打下良好基础。作者根据多年实践经验,总结出一系列实用的整洁代码操作规则,涵盖从命名到重构的各个编程方面。这些规则通过现实项目中的正反案例进行说明,让读者更易理解和应用。
(一)命名规范
在命名方面,强调使用能揭示意图的名称,避免误导信息,确保名称具有可读性和可搜索性。比如,一个函数名为“calculateTotalPrice”就比“calc”更能让人明白其功能。同时,要避免编码式命名,像匈牙利命名法,减少不必要的上下文信息,让命名更简洁准确。
(二)函数编写
对于函数,主张短小精悍,只做一件事,保持单一的抽象层次。函数参数要尽量简洁,避免使用标志参数,优先用异常处理错误,而不是返回错误代码。例如,一个函数如果既负责计算又负责打印结果,就不符合这一原则,应将计算和打印功能分开。
(三)注释与代码格式
注释不能用来弥补糟糕的代码,好的代码应尽量自我解释。如果需要注释,要确保其有价值,像解释意图、警告后果等。在代码格式上,注重垂直和水平方向的排版,保持代码的清晰易读,遵循团队统一的格式规则。
(四)对象和数据结构
在对象和数据结构方面,提倡数据抽象,遵循德米特法则,避免“火车残骸”式的代码,即避免过度调用对象的链式方法。同时,合理使用数据传输对象,让数据的传递更清晰高效。
二、原文摘录解读
书中提到“衡量代码质量的唯一有效标准:WTF/min”,意思是看阅读代码时每分钟产生“这是什么鬼”疑惑的次数,次数越少,代码质量越高。这一标准生动形象地说明了代码可读性的重要性。
如果你是程序员或技术经理,渴望提升代码质量,那么《代码整洁之道(英文版)》是一本不可多得的好书。感兴趣的朋友,赶紧下载学习吧!