《代码整洁之道》之旅(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

相关文章

Java集合之Iterator迭代器实现代码解析

《Java集合之Iterator迭代器实现代码解析》迭代器Iterator是Java集合框架中的一个核心接口,位于java.util包下,它定义了一种标准的元素访问机制,为各种集合类型提供了一种统一的... 目录一、什么是Iterator二、Iterator的核心方法三、基本使用示例四、Iterator的工

Java 线程池+分布式实现代码

《Java线程池+分布式实现代码》在Java开发中,池通过预先创建并管理一定数量的资源,避免频繁创建和销毁资源带来的性能开销,从而提高系统效率,:本文主要介绍Java线程池+分布式实现代码,需要... 目录1. 线程池1.1 自定义线程池实现1.1.1 线程池核心1.1.2 代码示例1.2 总结流程2. J

Python之变量命名规则详解

《Python之变量命名规则详解》Python变量命名需遵守语法规范(字母开头、不使用关键字),遵循三要(自解释、明确功能)和三不要(避免缩写、语法错误、滥用下划线)原则,确保代码易读易维护... 目录1. 硬性规则2. “三要” 原则2.1. 要体现变量的 “实际作用”,拒绝 “无意义命名”2.2. 要让

JS纯前端实现浏览器语音播报、朗读功能的完整代码

《JS纯前端实现浏览器语音播报、朗读功能的完整代码》在现代互联网的发展中,语音技术正逐渐成为改变用户体验的重要一环,下面:本文主要介绍JS纯前端实现浏览器语音播报、朗读功能的相关资料,文中通过代码... 目录一、朗读单条文本:① 语音自选参数,按钮控制语音:② 效果图:二、朗读多条文本:① 语音有默认值:②

Vue实现路由守卫的示例代码

《Vue实现路由守卫的示例代码》Vue路由守卫是控制页面导航的钩子函数,主要用于鉴权、数据预加载等场景,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着... 目录一、概念二、类型三、实战一、概念路由守卫(Navigation Guards)本质上就是 在路

uni-app小程序项目中实现前端图片压缩实现方式(附详细代码)

《uni-app小程序项目中实现前端图片压缩实现方式(附详细代码)》在uni-app开发中,文件上传和图片处理是很常见的需求,但也经常会遇到各种问题,下面:本文主要介绍uni-app小程序项目中实... 目录方式一:使用<canvas>实现图片压缩(推荐,兼容性好)示例代码(小程序平台):方式二:使用uni

JAVA实现Token自动续期机制的示例代码

《JAVA实现Token自动续期机制的示例代码》本文主要介绍了JAVA实现Token自动续期机制的示例代码,通过动态调整会话生命周期平衡安全性与用户体验,解决固定有效期Token带来的风险与不便,感兴... 目录1. 固定有效期Token的内在局限性2. 自动续期机制:兼顾安全与体验的解决方案3. 总结PS

C#中通过Response.Headers设置自定义参数的代码示例

《C#中通过Response.Headers设置自定义参数的代码示例》:本文主要介绍C#中通过Response.Headers设置自定义响应头的方法,涵盖基础添加、安全校验、生产实践及调试技巧,强... 目录一、基础设置方法1. 直接添加自定义头2. 批量设置模式二、高级配置技巧1. 安全校验机制2. 类型

Python屏幕抓取和录制的详细代码示例

《Python屏幕抓取和录制的详细代码示例》随着现代计算机性能的提高和网络速度的加快,越来越多的用户需要对他们的屏幕进行录制,:本文主要介绍Python屏幕抓取和录制的相关资料,需要的朋友可以参考... 目录一、常用 python 屏幕抓取库二、pyautogui 截屏示例三、mss 高性能截图四、Pill

使用MapStruct实现Java对象映射的示例代码

《使用MapStruct实现Java对象映射的示例代码》本文主要介绍了使用MapStruct实现Java对象映射的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,... 目录一、什么是 MapStruct?二、实战演练:三步集成 MapStruct第一步:添加 Mave