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

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

相关文章

C++使用栈实现括号匹配的代码详解

《C++使用栈实现括号匹配的代码详解》在编程中,括号匹配是一个常见问题,尤其是在处理数学表达式、编译器解析等任务时,栈是一种非常适合处理此类问题的数据结构,能够精确地管理括号的匹配问题,本文将通过C+... 目录引言问题描述代码讲解代码解析栈的状态表示测试总结引言在编程中,括号匹配是一个常见问题,尤其是在

Nginx设置连接超时并进行测试的方法步骤

《Nginx设置连接超时并进行测试的方法步骤》在高并发场景下,如果客户端与服务器的连接长时间未响应,会占用大量的系统资源,影响其他正常请求的处理效率,为了解决这个问题,可以通过设置Nginx的连接... 目录设置连接超时目的操作步骤测试连接超时测试方法:总结:设置连接超时目的设置客户端与服务器之间的连接

Java判断多个时间段是否重合的方法小结

《Java判断多个时间段是否重合的方法小结》这篇文章主要为大家详细介绍了Java中判断多个时间段是否重合的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录判断多个时间段是否有间隔判断时间段集合是否与某时间段重合判断多个时间段是否有间隔实体类内容public class D

Python使用国内镜像加速pip安装的方法讲解

《Python使用国内镜像加速pip安装的方法讲解》在Python开发中,pip是一个非常重要的工具,用于安装和管理Python的第三方库,然而,在国内使用pip安装依赖时,往往会因为网络问题而导致速... 目录一、pip 工具简介1. 什么是 pip?2. 什么是 -i 参数?二、国内镜像源的选择三、如何

IDEA编译报错“java: 常量字符串过长”的原因及解决方法

《IDEA编译报错“java:常量字符串过长”的原因及解决方法》今天在开发过程中,由于尝试将一个文件的Base64字符串设置为常量,结果导致IDEA编译的时候出现了如下报错java:常量字符串过长,... 目录一、问题描述二、问题原因2.1 理论角度2.2 源码角度三、解决方案解决方案①:StringBui

Linux使用nload监控网络流量的方法

《Linux使用nload监控网络流量的方法》Linux中的nload命令是一个用于实时监控网络流量的工具,它提供了传入和传出流量的可视化表示,帮助用户一目了然地了解网络活动,本文给大家介绍了Linu... 目录简介安装示例用法基础用法指定网络接口限制显示特定流量类型指定刷新率设置流量速率的显示单位监控多个

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下:需要在

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》:本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程

C#中读取XML文件的四种常用方法

《C#中读取XML文件的四种常用方法》Xml是Internet环境中跨平台的,依赖于内容的技术,是当前处理结构化文档信息的有力工具,下面我们就来看看C#中读取XML文件的方法都有哪些吧... 目录XML简介格式C#读取XML文件方法使用XmlDocument使用XmlTextReader/XmlTextWr

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.