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

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

相关文章

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部

Maven 配置中的 <mirror>绕过 HTTP 阻断机制的方法

《Maven配置中的<mirror>绕过HTTP阻断机制的方法》:本文主要介绍Maven配置中的<mirror>绕过HTTP阻断机制的方法,本文给大家分享问题原因及解决方案,感兴趣的朋友一... 目录一、问题场景:升级 Maven 后构建失败二、解决方案:通过 <mirror> 配置覆盖默认行为1. 配置示

SpringBoot排查和解决JSON解析错误(400 Bad Request)的方法

《SpringBoot排查和解决JSON解析错误(400BadRequest)的方法》在开发SpringBootRESTfulAPI时,客户端与服务端的数据交互通常使用JSON格式,然而,JSON... 目录问题背景1. 问题描述2. 错误分析解决方案1. 手动重新输入jsON2. 使用工具清理JSON3.

使用jenv工具管理多个JDK版本的方法步骤

《使用jenv工具管理多个JDK版本的方法步骤》jenv是一个开源的Java环境管理工具,旨在帮助开发者在同一台机器上轻松管理和切换多个Java版本,:本文主要介绍使用jenv工具管理多个JD... 目录一、jenv到底是干啥的?二、jenv的核心功能(一)管理多个Java版本(二)支持插件扩展(三)环境隔

SQL中JOIN操作的条件使用总结与实践

《SQL中JOIN操作的条件使用总结与实践》在SQL查询中,JOIN操作是多表关联的核心工具,本文将从原理,场景和最佳实践三个方面总结JOIN条件的使用规则,希望可以帮助开发者精准控制查询逻辑... 目录一、ON与WHERE的本质区别二、场景化条件使用规则三、最佳实践建议1.优先使用ON条件2.WHERE用

Java中Map.Entry()含义及方法使用代码

《Java中Map.Entry()含义及方法使用代码》:本文主要介绍Java中Map.Entry()含义及方法使用的相关资料,Map.Entry是Java中Map的静态内部接口,用于表示键值对,其... 目录前言 Map.Entry作用核心方法常见使用场景1. 遍历 Map 的所有键值对2. 直接修改 Ma

Mybatis Plus Join使用方法示例详解

《MybatisPlusJoin使用方法示例详解》:本文主要介绍MybatisPlusJoin使用方法示例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,... 目录1、pom文件2、yaml配置文件3、分页插件4、示例代码:5、测试代码6、和PageHelper结合6

Java中实现线程的创建和启动的方法

《Java中实现线程的创建和启动的方法》在Java中,实现线程的创建和启动是两个不同但紧密相关的概念,理解为什么要启动线程(调用start()方法)而非直接调用run()方法,是掌握多线程编程的关键,... 目录1. 线程的生命周期2. start() vs run() 的本质区别3. 为什么必须通过 st

C#之List集合去重复对象的实现方法

《C#之List集合去重复对象的实现方法》:本文主要介绍C#之List集合去重复对象的实现方法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C# List集合去重复对象方法1、测试数据2、测试数据3、知识点补充总结C# List集合去重复对象方法1、测试数据