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

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

相关文章

jupyter代码块没有运行图标的解决方案

《jupyter代码块没有运行图标的解决方案》:本文主要介绍jupyter代码块没有运行图标的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录jupyter代码块没有运行图标的解决1.找到Jupyter notebook的系统配置文件2.这时候一般会搜索到

Redis实现延迟任务的三种方法详解

《Redis实现延迟任务的三种方法详解》延迟任务(DelayedTask)是指在未来的某个时间点,执行相应的任务,本文为大家整理了三种常见的实现方法,感兴趣的小伙伴可以参考一下... 目录1.前言2.Redis如何实现延迟任务3.代码实现3.1. 过期键通知事件实现3.2. 使用ZSet实现延迟任务3.3

idea maven编译报错Java heap space的解决方法

《ideamaven编译报错Javaheapspace的解决方法》这篇文章主要为大家详细介绍了ideamaven编译报错Javaheapspace的相关解决方法,文中的示例代码讲解详细,感兴趣的... 目录1.增加 Maven 编译的堆内存2. 增加 IntelliJ IDEA 的堆内存3. 优化 Mave

Java String字符串的常用使用方法

《JavaString字符串的常用使用方法》String是JDK提供的一个类,是引用类型,并不是基本的数据类型,String用于字符串操作,在之前学习c语言的时候,对于一些字符串,会初始化字符数组表... 目录一、什么是String二、如何定义一个String1. 用双引号定义2. 通过构造函数定义三、St

Python通过模块化开发优化代码的技巧分享

《Python通过模块化开发优化代码的技巧分享》模块化开发就是把代码拆成一个个“零件”,该封装封装,该拆分拆分,下面小编就来和大家简单聊聊python如何用模块化开发进行代码优化吧... 目录什么是模块化开发如何拆分代码改进版:拆分成模块让模块更强大:使用 __init__.py你一定会遇到的问题模www.

Spring Security方法级安全控制@PreAuthorize注解的灵活运用小结

《SpringSecurity方法级安全控制@PreAuthorize注解的灵活运用小结》本文将带着大家讲解@PreAuthorize注解的核心原理、SpEL表达式机制,并通过的示例代码演示如... 目录1. 前言2. @PreAuthorize 注解简介3. @PreAuthorize 核心原理解析拦截与

一文详解JavaScript中的fetch方法

《一文详解JavaScript中的fetch方法》fetch函数是一个用于在JavaScript中执行HTTP请求的现代API,它提供了一种更简洁、更强大的方式来处理网络请求,:本文主要介绍Jav... 目录前言什么是 fetch 方法基本语法简单的 GET 请求示例代码解释发送 POST 请求示例代码解释

Feign Client超时时间设置不生效的解决方法

《FeignClient超时时间设置不生效的解决方法》这篇文章主要为大家详细介绍了FeignClient超时时间设置不生效的原因与解决方法,具有一定的的参考价值,希望对大家有一定的帮助... 在使用Feign Client时,可以通过两种方式来设置超时时间:1.针对整个Feign Client设置超时时间

C/C++错误信息处理的常见方法及函数

《C/C++错误信息处理的常见方法及函数》C/C++是两种广泛使用的编程语言,特别是在系统编程、嵌入式开发以及高性能计算领域,:本文主要介绍C/C++错误信息处理的常见方法及函数,文中通过代码介绍... 目录前言1. errno 和 perror()示例:2. strerror()示例:3. perror(

CSS去除a标签的下划线的几种方法

《CSS去除a标签的下划线的几种方法》本文给大家分享在CSS中,去除a标签(超链接)的下划线的几种方法,本文给大家介绍的非常详细,感兴趣的朋友一起看看吧... 在 css 中,去除a标签(超链接)的下划线主要有以下几种方法:使用text-decoration属性通用选择器设置:使用a标签选择器,将tex