一:有意义的命名
避免使用编码
把类型或作用域编进名称里面,徒然增加了解码的负担。
每个概念对应一个词
使用解决方案领域名称
记住,只有程序员才会读你的代码。所以,尽管用那些计算机科学(Computer Science,CS)术语、算法名、模式名、数学术语吧。依据问题所涉领域来命名可不算是聪明的做法,因为不该让协作者老是跑去问客户每个名称的含义,其实他们早该通过另一名称了解这个概念了。
对于熟悉访问者(VISITOR)模式的程序来说,名称AccountVisitor富有意义。哪个程序员会不知道JobQueue的意思呢?程序员要做太多技术性工作。给这些事取个技术性的名称,通常是最靠谱的做法。
使用源自所涉问题领域的名称
如果不能用程序员熟悉的术语来给手头的工作命名,就采用从所涉问题领域而来的名称吧。至少,负责维护代码的程序员就能去请教领域专家了。
优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的概念。与所涉问题领域更为贴近的代码,应当采用源自问题领域的名称。
函数:
只做一件事
如果函数只是做了该函数名下同一抽象层上的步骤,则函数还是只做了一件事。编写函数毕竟是为了把大一些的概念(换言之,函数的名称)拆分为另一抽象层上的一系列步骤。
每个函数一个抽象层级
要确保函数只做一件事,函数中的语句都要在同一抽象层级上。
ps:聪明程序员和专业程序员之间的区别在于,专业程序员了解,明确是王道。专业程序员善用其能,编写其他人能理解的代码。
分享到:
相关推荐
阅读《代码整洁之道》这本书的《逐步改进》、《JUnit内幕》这两章内容时写的demo
代码整洁之道是一本主要写代码规范的书籍,我读完以后为了给同事们分享里面的重点知识,做了几个幻灯片,主要是各个知识点和笔记。
《代码整洁之道》读书笔记
个人阅读代码整洁之道所做的笔记
* 整洁代码的意义? 可读性,可维护性。 * 如何写出整洁代码? 1.只做一件事 2.不重复 3.有表达力 * 整洁代码的态度要求,要遵守的军规? 专业 和责任。让营地比你来时更干净,拒绝破窗效应。 * 写出整洁...
这是有关代码整洁之道的幻灯片笔记,简单介绍了本书的一些重点知识点。
代码坏味道与启发--《代码整洁之道》总结.pdf
代码整洁之道读书笔记
该文档是《代码整洁之道》的经典语句,能够帮助读者了解该书的主要内容。同时,本文档对软件工程师的工作也有一定的帮助!
[Prentice Hall] 代码整洁之道 [Prentice Hall] Clean Code A Handbook of Agile Software Craftsmanship (E-Book) ☆ 出版信息:☆ [出版机构] Prentice Hall [出版日期] 2008年08月01日 [图书页数] 466页 ...
一个偶然的机会读了代码整洁之道,觉得这本书写的很好,所以就将里面自己觉得很经典的内容记录下来,作为自己以后写代码的标准和准则。同时也为那些曾经困惑过的人一点参考吧~!1.需求与代码哪个重要?答:并不是...
CleanCode代码整洁之道培训总结(2015-03-14)-附件资源
它们仅用于参考,不过要知道这些原则都是《代码整洁之道》的作者们累积多年的集体经验。 我们在软件工程方面的技术发展刚刚超过 50 年,我们仍然在学习很多东西。当软件架构和架构本身一样古老的时候,我们应该遵循...
现在的软件系统开发难度主要在于其复杂度和规模,客户需求也不再像WinstonRoyce瀑布模型期望那样在系统编码...在《代码整洁之道》(Clean Code),提出一种软件质量,可持续开发不仅在于项目架构设计,还与代码质量密切