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

相关文章

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

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

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

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

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景

Python中顺序结构和循环结构示例代码

《Python中顺序结构和循环结构示例代码》:本文主要介绍Python中的条件语句和循环语句,条件语句用于根据条件执行不同的代码块,循环语句用于重复执行一段代码,文章还详细说明了range函数的使... 目录一、条件语句(1)条件语句的定义(2)条件语句的语法(a)单分支 if(b)双分支 if-else(

MySQL数据库函数之JSON_EXTRACT示例代码

《MySQL数据库函数之JSON_EXTRACT示例代码》:本文主要介绍MySQL数据库函数之JSON_EXTRACT的相关资料,JSON_EXTRACT()函数用于从JSON文档中提取值,支持对... 目录前言基本语法路径表达式示例示例 1: 提取简单值示例 2: 提取嵌套值示例 3: 提取数组中的值注意

CSS3中使用flex和grid实现等高元素布局的示例代码

《CSS3中使用flex和grid实现等高元素布局的示例代码》:本文主要介绍了使用CSS3中的Flexbox和Grid布局实现等高元素布局的方法,通过简单的两列实现、每行放置3列以及全部代码的展示,展示了这两种布局方式的实现细节和效果,详细内容请阅读本文,希望能对你有所帮助... 过往的实现方法是使用浮动加

JAVA调用Deepseek的api完成基本对话简单代码示例

《JAVA调用Deepseek的api完成基本对话简单代码示例》:本文主要介绍JAVA调用Deepseek的api完成基本对话的相关资料,文中详细讲解了如何获取DeepSeekAPI密钥、添加H... 获取API密钥首先,从DeepSeek平台获取API密钥,用于身份验证。添加HTTP客户端依赖使用Jav

Java实现状态模式的示例代码

《Java实现状态模式的示例代码》状态模式是一种行为型设计模式,允许对象根据其内部状态改变行为,本文主要介绍了Java实现状态模式的示例代码,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来... 目录一、简介1、定义2、状态模式的结构二、Java实现案例1、电灯开关状态案例2、番茄工作法状态案例

nginx-rtmp-module模块实现视频点播的示例代码

《nginx-rtmp-module模块实现视频点播的示例代码》本文主要介绍了nginx-rtmp-module模块实现视频点播,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习... 目录预置条件Nginx点播基本配置点播远程文件指定多个播放位置参考预置条件配置点播服务器 192.

CSS自定义浏览器滚动条样式完整代码

《CSS自定义浏览器滚动条样式完整代码》:本文主要介绍了如何使用CSS自定义浏览器滚动条的样式,包括隐藏滚动条的角落、设置滚动条的基本样式、轨道样式和滑块样式,并提供了完整的CSS代码示例,通过这些技巧,你可以为你的网站添加个性化的滚动条样式,从而提升用户体验,详细内容请阅读本文,希望能对你有所帮助...