《代码整洁之道》读后总结--关于方法

2024-03-29 06:58

本文主要是介绍《代码整洁之道》读后总结--关于方法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1.几个问题:

Q1:  怎样让代码(函数中含有大量的代码行,大量的信息)易于理解?

Q2:  怎样让函数表达其意图?

Q3:  给函数哪些属性,以便让读者一看便明白函数术语怎样的程序?


2.简单的原则:

2.1. 短小

  • 作者认为函数应该尽量短小
  • 每行字符的数量要有限,  并且 每个 函数20行 封顶最佳。(建议)
  • if语句 , else 语句, while语句中等, 代码块应该只有一行 (函数调用语句)。
  • 函数不应该大到足以容纳嵌套结构。(表现为 缩进层级 <= 1层 或者 2层

2.2. 只做一件事情

  • 函数只做一件事情。 做好这件事情。这做这件事情。
  • 判断 1:如果函数只是做了该函数名下同一抽象层次上的步骤,函数做了一件事情。

什么叫做同一抽象层次?

  • 判断2 :看是否能从函数中再拆出一个函数。

2.3. 每个函数一个抽象层次

确保函数只做一件事情 。 <-- (函数中语句在同一抽象层次

  • 函数抽象层次混杂造成的影响, 让人困惑不解。(读者无法判断是基础概念,还是细节)
  • 混杂还会进一步,让更多的细节在函数中纠结起来。
  • 自顶向下读代码: 向下规则

每个函数后面都跟着下一抽象等级的函数。这样子便可以循抽象层级向下阅读。

(想象一棵层次树,不同层级代表不同的抽象等级)

(分层的结构在这里也得到了很好的体现)

(体现为句法为 :  为了(TO) ...,而 ...

程序员需要确保自己写出只停留于一个抽象等级上的函数。(不要在多层之间混淆

2.4. Switch语句

  • 写出短小的switch语句很难。switch 天生要做N件事情。
  • 确保switch 埋藏在较低的抽象层次,且永远不重复。(通过多态来实现这一点)
  • 例 :  将switch 语句埋到抽象工厂底下,不让任何人看到。
  • 作者的规矩: switch 只出现一次,这一次用来创建多态对象。(好的技巧)

2.5. 使用描述性的名称

  • 函数长而具有描述性的名称,比描述性的长注释要好。
  • 别怕花时间取名字。
  • 选择描述性的名称能理清你关于模块的设计思路,帮你改进。追求好名称,往往导致对代码的改善重构。
  • 命名方式要保持一致。使用与模块名具有相似性的短语,名词,动词给函数名。例如,includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage...。

2.6. 函数参数

待续...

这篇关于《代码整洁之道》读后总结--关于方法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/857916

相关文章

MySQL查询JSON数组字段包含特定字符串的方法

《MySQL查询JSON数组字段包含特定字符串的方法》在MySQL数据库中,当某个字段存储的是JSON数组,需要查询数组中包含特定字符串的记录时传统的LIKE语句无法直接使用,下面小编就为大家介绍两种... 目录问题背景解决方案对比1. 精确匹配方案(推荐)2. 模糊匹配方案参数化查询示例使用场景建议性能优

关于集合与数组转换实现方法

《关于集合与数组转换实现方法》:本文主要介绍关于集合与数组转换实现方法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、Arrays.asList()1.1、方法作用1.2、内部实现1.3、修改元素的影响1.4、注意事项2、list.toArray()2.1、方

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,:本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释?示例:三、单行注释语法:以 China编程# 开头,后面的内容为注释内容示例:示例:四

JavaSE正则表达式用法总结大全

《JavaSE正则表达式用法总结大全》正则表达式就是由一些特定的字符组成,代表的是一个规则,:本文主要介绍JavaSE正则表达式用法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录常用的正则表达式匹配符正则表China编程达式常用的类Pattern类Matcher类PatternSynta

一文详解Git中分支本地和远程删除的方法

《一文详解Git中分支本地和远程删除的方法》在使用Git进行版本控制的过程中,我们会创建多个分支来进行不同功能的开发,这就容易涉及到如何正确地删除本地分支和远程分支,下面我们就来看看相关的实现方法吧... 目录技术背景实现步骤删除本地分支删除远程www.chinasem.cn分支同步删除信息到其他机器示例步骤

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Visual Studio 2022 编译C++20代码的图文步骤

《VisualStudio2022编译C++20代码的图文步骤》在VisualStudio中启用C++20import功能,需设置语言标准为ISOC++20,开启扫描源查找模块依赖及实验性标... 默认创建Visual Studio桌面控制台项目代码包含C++20的import方法。右键项目的属性:

在Golang中实现定时任务的几种高效方法

《在Golang中实现定时任务的几种高效方法》本文将详细介绍在Golang中实现定时任务的几种高效方法,包括time包中的Ticker和Timer、第三方库cron的使用,以及基于channel和go... 目录背景介绍目的和范围预期读者文档结构概述术语表核心概念与联系故事引入核心概念解释核心概念之间的关系

MySQL数据库的内嵌函数和联合查询实例代码

《MySQL数据库的内嵌函数和联合查询实例代码》联合查询是一种将多个查询结果组合在一起的方法,通常使用UNION、UNIONALL、INTERSECT和EXCEPT关键字,下面:本文主要介绍MyS... 目录一.数据库的内嵌函数1.1聚合函数COUNT([DISTINCT] expr)SUM([DISTIN

在Linux终端中统计非二进制文件行数的实现方法

《在Linux终端中统计非二进制文件行数的实现方法》在Linux系统中,有时需要统计非二进制文件(如CSV、TXT文件)的行数,而不希望手动打开文件进行查看,例如,在处理大型日志文件、数据文件时,了解... 目录在linux终端中统计非二进制文件的行数技术背景实现步骤1. 使用wc命令2. 使用grep命令