一:有意义的命名
避免使用编码
把类型或作用域编进名称里面,徒然增加了解码的负担。
每个概念对应一个词
使用解决方案领域名称
记住,只有程序员才会读你的代码。所以,尽管用那些计算机科学(Computer Science,CS)术语、算法名、模式名、数学术语吧。依据问题所涉领域来命名可不算是聪明的做法,因为不该让协作者老是跑去问客户每个名称的含义,其实他们早该通过另一名称了解这个概念了。
对于熟悉访问者(VISITOR)模式的程序来说,名称AccountVisitor富有意义。哪个程序员会不知道JobQueue的意思呢?程序员要做太多技术性工作。给这些事取个技术性的名称,通常是最靠谱的做法。
使用源自所涉问题领域的名称
如果不能用程序员熟悉的术语来给手头的工作命名,就采用从所涉问题领域而来的名称吧。至少,负责维护代码的程序员就能去请教领域专家了。
优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的概念。与所涉问题领域更为贴近的代码,应当采用源自问题领域的名称。
函数:
只做一件事
如果函数只是做了该函数名下同一抽象层上的步骤,则函数还是只做了一件事。编写函数毕竟是为了把大一些的概念(换言之,函数的名称)拆分为另一抽象层上的一系列步骤。
每个函数一个抽象层级
要确保函数只做一件事,函数中的语句都要在同一抽象层级上。
ps:聪明程序员和专业程序员之间的区别在于,专业程序员了解,明确是王道。专业程序员善用其能,编写其他人能理解的代码。
分享到:
相关推荐
《代码整洁之道》是软件开发领域的一本经典之作,由著名程序员Robert C. Martin(Uncle Bob)撰写。这本书强调了代码质量的重要性,尤其是整洁、可读和易于维护的代码对于项目成功的关键作用。在“逐步改进”和...
《代码整洁之道》是软件开发领域的一本经典著作,作者是Robert C. Martin(简称Uncle Bob)。这本书强调了编写可读性好、易于维护的代码的重要性,提出了许多关于代码整洁性的原则和实践方法。以下是对书中核心知识...
代码整洁之道.pdf
《代码整洁之道》是软件开发领域的一本经典著作,由著名程序员Robert C. Martin(也称为Uncle Bob)所著。这本书主要关注如何通过编写整洁、可读性强的代码来提高软件的质量和可维护性。幻灯片笔记是对这本书内容的...
### 代码整洁之道的核心知识点梳理 #### 一、基本原则与理念 **1. LeBlanc & Late equals never:** - **原则概述:** 这条原则强调的是代码编写的时间节点对于后期维护的重要性。如果在项目初期没有良好的规划与...
* 整洁代码的意义? 可读性,可维护性。 * 如何写出整洁代码? 1.只做一件事 2.不重复 3.有表达力 * 整洁代码的态度要求,要遵守的军规? 专业 和责任。让营地比你来时更干净,拒绝破窗效应。 * 写出整洁...
### 软件开发+架构基础+代码整洁之道 #### 一、引言 随着软件项目的日益复杂化,保持代码的整洁与可维护性成为软件工程师必须面对的重要问题。本书《软件开发+架构基础+代码整洁之道》旨在帮助开发者理解和实践高...
读书笔记之代码整洁之道
《代码整洁之道》是软件开发领域的一本经典之作,作者是Robert C. Martin(简称Uncle Bob)。这本书主要探讨了如何通过编写整洁、易于理解的代码来提高软件的质量和可维护性,尤其针对Java编程语言提供了许多实用的...
代码整洁之道笔记-博客有
读书笔记:代码整洁之道
《你所需要知道的代码整洁之道》 编程不仅仅是让计算机执行指令,更是一种沟通的艺术,它面向的是人类读者。Donald Ervin Knuth的名言“程序是写给人读的,只是偶尔让计算机执行一下”强调了代码的可读性和可维护性...
读书笔记:代码整洁之道翻译
读书笔记:TypeScript 代码整洁之道