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

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

相关文章

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

MySQL数据库双机热备的配置方法详解

《MySQL数据库双机热备的配置方法详解》在企业级应用中,数据库的高可用性和数据的安全性是至关重要的,MySQL作为最流行的开源关系型数据库管理系统之一,提供了多种方式来实现高可用性,其中双机热备(M... 目录1. 环境准备1.1 安装mysql1.2 配置MySQL1.2.1 主服务器配置1.2.2 从

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法:2、使用str方法:3、使用循环和字符串拼接:4、使用字符

Python版本与package版本兼容性检查方法总结

《Python版本与package版本兼容性检查方法总结》:本文主要介绍Python版本与package版本兼容性检查方法的相关资料,文中提供四种检查方法,分别是pip查询、conda管理、PyP... 目录引言为什么会出现兼容性问题方法一:用 pip 官方命令查询可用版本方法二:conda 管理包环境方法

Linux云服务器手动配置DNS的方法步骤

《Linux云服务器手动配置DNS的方法步骤》在Linux云服务器上手动配置DNS(域名系统)是确保服务器能够正常解析域名的重要步骤,以下是详细的配置方法,包括系统文件的修改和常见问题的解决方案,需要... 目录1. 为什么需要手动配置 DNS?2. 手动配置 DNS 的方法方法 1:修改 /etc/res

JavaScript对象转数组的三种方法实现

《JavaScript对象转数组的三种方法实现》本文介绍了在JavaScript中将对象转换为数组的三种实用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友... 目录方法1:使用Object.keys()和Array.map()方法2:使用Object.entr

pycharm跑python项目易出错的问题总结

《pycharm跑python项目易出错的问题总结》:本文主要介绍pycharm跑python项目易出错问题的相关资料,当你在PyCharm中运行Python程序时遇到报错,可以按照以下步骤进行排... 1. 一定不要在pycharm终端里面创建环境安装别人的项目子模块等,有可能出现的问题就是你不报错都安装

Java集合之Iterator迭代器实现代码解析

《Java集合之Iterator迭代器实现代码解析》迭代器Iterator是Java集合框架中的一个核心接口,位于java.util包下,它定义了一种标准的元素访问机制,为各种集合类型提供了一种统一的... 目录一、什么是Iterator二、Iterator的核心方法三、基本使用示例四、Iterator的工

SpringBoot中ResponseEntity的使用方法举例详解

《SpringBoot中ResponseEntity的使用方法举例详解》ResponseEntity是Spring的一个用于表示HTTP响应的全功能对象,它可以包含响应的状态码、头信息及响应体内容,下... 目录一、ResponseEntity概述基本特点:二、ResponseEntity的基本用法1. 创