《代码整洁之道》之旅(2)——第2章:有意义的命名

2024-08-23 03:48

本文主要是介绍《代码整洁之道》之旅(2)——第2章:有意义的命名,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

  备注:文章中出现的章节序号均与书本一致,其中有些章节没有记录点就直接跳过了。

第2章 有意义的命名

2.2 名副其实

这里写图片描述
  以下举个例子:
  这里写图片描述
  上面带来的问题不在于代码的简洁度,而是在于代码的模糊度,上列代码要求我们了解以下问题的答案:
  (1)theList是什么类型的东西?
  (2)theList零下标条目的意义是什么?
  (3)值4的意义是什么?
  (4)我怎么使用返回的列表?
  以下是针对上列代码修改的建议。
  假如开发一个扫雷游戏,theList代表单元格列表,那么就将其名称改为gameBoard。盘面每个单元格都用一个简单数组表示。零下标条目是一种状态值,而该种状态值为4表示“已标记”,改进的代码如下:
  这里写图片描述
  这里写图片描述

2.3 避免误导

这里写图片描述
这里写图片描述

2.4 做有意义的区分

这里写图片描述
这里写图片描述
这里写图片描述
  比较以下两段代码,你就体会到说人话的代码的重要性:
  这里写图片描述

2.6 使用可搜索的名称

这里写图片描述

2.9 类名

这里写图片描述

2.10 方法名

这里写图片描述

2.12 每个概念对应一个词

这里写图片描述

2.13 别用双关语

这里写图片描述

2.14 使用解决方案领域名称

这里写图片描述

2.16 添加有意义的语境

这里写图片描述
这里写图片描述
这里写图片描述
这里写图片描述

2.17 不要添加没用的语境

这里写图片描述

  第2章整理内容在此算是结束了。这章主要鼓励大家用有意义的命名以及怎么写有意义的命名。一个好的命名可以易于他人阅读,也易于自己写代码时回看。
  如果在写代码时,对于更好命名,你有比《代码整洁之道》更好的建议,希望不吝回复本文章,大家一同进步,一同写整洁的代码。

这篇关于《代码整洁之道》之旅(2)——第2章:有意义的命名的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

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

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

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

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

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤