《代码整洁之道:CleanCode》学习总结

2024-05-26 00:08

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

 

  • 概括总结:
  1. 整洁代码:

培养整洁代码的意识,经常维护项目中的模块保持整洁。整洁的代码增强可维护性,并且能提高工作效率。

     2.有意义的命名:

名副其实的命名,变量名,函数,类名等。命名也有意义且能让人读懂。错误示例:名字没有含义,a1 a2。

     3.函数:

函数要单一,并且只做一件事。这样不容易出错,并且好复用,可维护性强大。

     4.注释:

尽量不写注释,注释不要有废话,注释最后的作用是提供有用的信息。

    5.格式:

保持项目中的风格格式统一,便于团队开发,并且阅读代码方便,也有美感。

    6.对象和数据结构:

对象和数据结构是两个概念,写代码的时候,尽量拆分开,不要混在一起。

    7.错误处理:

错误处理要调用方便,不要和逻辑业务耦合在一起。

 

  • 开发中的实践运用:

(1)整洁代码:

  1. 整洁代码是美观的,并且可读性强
  2. 整洁的代码,意义清晰,直观,可维护性强
  3. 没有重复的代码,尽量短小的实体
  4. 经常维护代码的整洁,碰到修改的模块,要顺手修改
  5. 培养代码整洁的意识

 

2)有意义的命名:

  1. 变量名不要太相近,容易混乱。
  1. A1a2的区分没有意义,并且容易乱,要起个排列的名字进行区分。
  2. 变量名不要是废话,比如叫变量,叫class,叫list,要有意义。
  1. 起名要方便读和认,不要起很奇怪的名字。
  2. 起名字要有特殊性,不要太大众,不便于搜索。
  3. 遵循驼峰命名法
  4. 全局变量和局部变量,又要命名区分。比如全局带m。
  5. 有些特定的名字,就不要来命名变量了,比如i,j等。
  6. 类名要短小,不要太长,函数名要是动词or动词 短语。

 

 

3)函数:

  1. 函数要短小精悍,越短越好。
  2. 封装的逻辑只处理单一,不要混杂在一起。
  3. Switch使用要避免重复。
  4. 函数要有个好名字,参见命名(1)。
  5. 参数要少,很多参数可以封装成对象传递。
  6. 尽量避免,一元函数,一般处理event,需要有返回值。
  7. 参数尽量不要为boolean,把两个处理封装成两个函数。
  8. 函数为动词命名。
  9. 抽离trycatch代码块,函数返回错误码。
  10. 相同作用的代码,抽成共用函数。

 

4)注释:

  1. 少些注释,良好的命名,就不太需要写注释。
  2. 做好判断逻辑的函数封装,可以少写注释。
  3. 注释是来提供信息(约定俗成的信息等)。
  4. 阐述逻辑。
  5. TODO注释,添加工作列表。
  6. 不要写多余无用的注释。

 

5)格式:

  1. 代码从上到下排列,变量,函数等。
  2. 相同属性的代码之间,可以关系更紧密,没有空行,比如变量。
  3. 项目格式化文件,敲代码的时候,多用,保持风格一致,缩进,排列。

 

6)对象和数据结构:

  1. getset封装的是本地,具体实现是私有不可见的。
  2. 面向对象和面向过程,看情况选择,并不是某种就特别好。
  3. 迪米特Demeter法则,模块操作对象,不需要了解对象内的数据实现。
  4. 避免火车失事写法,即:一连串的函数调用。
  5. 避免混杂,对象和数据结构要分开。

 

7)错误处理(强固又整洁的代码):

  1. 根据返回码对应处理相应的情况,不要和逻辑掺杂在一起。
  2. 可能会抛出异常的代码,需要使用try-Catch-finally捕捉。
  3. 使用不可控异常处理,可控异常处理维护成本高。
  4. 在异常可能发生的代码,添加日志记录操作行为,便于修改问题。
  5. 记录异常时,可以直接记录错误类型,不用根据不同的错误类型打印日志,减少无用代码。
  6. 异常处理需要添加开关,可以选择处理异常,也可以不处理。
  7. 异常处理,不要返回null。增加了判空和后续调用的工作量。
  8. 参数不要传null,容易空异常崩溃,还要添加判空处理。

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



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

相关文章

HarmonyOS学习(七)——UI(五)常用布局总结

自适应布局 1.1、线性布局(LinearLayout) 通过线性容器Row和Column实现线性布局。Column容器内的子组件按照垂直方向排列,Row组件中的子组件按照水平方向排列。 属性说明space通过space参数设置主轴上子组件的间距,达到各子组件在排列上的等间距效果alignItems设置子组件在交叉轴上的对齐方式,且在各类尺寸屏幕上表现一致,其中交叉轴为垂直时,取值为Vert

Ilya-AI分享的他在OpenAI学习到的15个提示工程技巧

Ilya(不是本人,claude AI)在社交媒体上分享了他在OpenAI学习到的15个Prompt撰写技巧。 以下是详细的内容: 提示精确化:在编写提示时,力求表达清晰准确。清楚地阐述任务需求和概念定义至关重要。例:不用"分析文本",而用"判断这段话的情感倾向:积极、消极还是中性"。 快速迭代:善于快速连续调整提示。熟练的提示工程师能够灵活地进行多轮优化。例:从"总结文章"到"用

【前端学习】AntV G6-08 深入图形与图形分组、自定义节点、节点动画(下)

【课程链接】 AntV G6:深入图形与图形分组、自定义节点、节点动画(下)_哔哩哔哩_bilibili 本章十吾老师讲解了一个复杂的自定义节点中,应该怎样去计算和绘制图形,如何给一个图形制作不间断的动画,以及在鼠标事件之后产生动画。(有点难,需要好好理解) <!DOCTYPE html><html><head><meta charset="UTF-8"><title>06

学习hash总结

2014/1/29/   最近刚开始学hash,名字很陌生,但是hash的思想却很熟悉,以前早就做过此类的题,但是不知道这就是hash思想而已,说白了hash就是一个映射,往往灵活利用数组的下标来实现算法,hash的作用:1、判重;2、统计次数;

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合,内部除了存储元素外,还会存储一个score,存储在zset中的元素会按照score的大小升序排列,不同元素的score可以重复,score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]

poj 1258 Agri-Net(最小生成树模板代码)

感觉用这题来当模板更适合。 题意就是给你邻接矩阵求最小生成树啦。~ prim代码:效率很高。172k...0ms。 #include<stdio.h>#include<algorithm>using namespace std;const int MaxN = 101;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int n

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程(Gaussian Process,简称GP)是一种概率模型,用于描述一组随机变量的联合概率分布,其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高斯过程的特性1.2.1 联合高斯性1.2.2 均值函数1.2.3 协方差函数(或核函数) 1.3 核函数1.4 高斯过程回归(Gauss

git使用的说明总结

Git使用说明 下载安装(下载地址) macOS: Git - Downloading macOS Windows: Git - Downloading Windows Linux/Unix: Git (git-scm.com) 创建新仓库 本地创建新仓库:创建新文件夹,进入文件夹目录,执行指令 git init ,用以创建新的git 克隆仓库 执行指令用以创建一个本地仓库的

【学习笔记】 陈强-机器学习-Python-Ch15 人工神经网络(1)sklearn

系列文章目录 监督学习:参数方法 【学习笔记】 陈强-机器学习-Python-Ch4 线性回归 【学习笔记】 陈强-机器学习-Python-Ch5 逻辑回归 【课后题练习】 陈强-机器学习-Python-Ch5 逻辑回归(SAheart.csv) 【学习笔记】 陈强-机器学习-Python-Ch6 多项逻辑回归 【学习笔记 及 课后题练习】 陈强-机器学习-Python-Ch7 判别分析 【学