名字很重要

2024-06-23 03:18
文章标签 重要 名字

本文主要是介绍名字很重要,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

是什么

在编程中,我们要将命名视为最重要的课题,谨慎对待。

“命名”这一行为和它的产物“名字”都具有非常重要的价值。

  • 命名

取了一个合适的名字意味着元素被正确理解并被正确地设计了出来。相反,如果取的名字不合适,就证明程序员还没有充分理解该元素的作用

  • 名字本身

程序员之间通过代码进行交流时,名字传递的信息是最多的。

写代码的人和读代码的人很少能站在一起实时进行对话。程序员之间大多通过代码进行交流,一旦名字不够贴切,代码上的沟通就会出现障碍。

为了让这种非实时对话能够顺畅进行,我们必须最大限度地在名字上下功夫。

为什么

名字是面向代码阅读者的“用户界面”。各元素都有适当名字的代码能有效传达其意图,让人充分理解某个东西是怎么做出来的。

以给函数命名为例,名字恰当易懂的函数能通过名字表达其职责,这有助于隐藏函数的内部处理。从结果来看,有以下好处。

  • 在阅读代码时,只看函数名就能大致掌握其内部处理,因此可以跳着阅读内部代码。
  • 在编写代码时,函数名能帮我们理解该函数的目的以及用法,使函数调用变得简单。对编写完的代码来说,恰当的名字起到了说明作用,使代码的可读性大大提高。

程序员并不是因为想读代码才去读的,在充分理解代码之后对其进行修改或添加功能才是他们真正的目的。在阅读代码时,混乱的名字会占用所有的脑部资源,妨碍原本应该进行的作业,使程序员无法着手处理问题。

琢磨名字需要花费很多精力,要想取一个恰当的名字,我们得有强大的思考能力,还要舍得花时间。相反,随便取一个名字不仅不会影响函数的运行,还能节约时间。

不恰当的名字会让代码“负债”,此后,只要代码还在使用,读代码的人、用代码的人都将会受到负面影响。

怎么做

编程要先从名字入手,先给代码中会出现的各个元素取一个能够准确表达意图的名字。

在编写代码的过程中也要时常站在代码使用者和阅读者的角度命名。具体来说,注意以下几点:

  • 名字中尽量多包含信息。将名字视为简短的注释有助于将必要的信息添加进去,可以多准备几个名字,从中选择最合适的一个,这样能进一步提高名字的质量。
  • 名字不能有歧义。命名之后,多问自己几遍这个名字是否有歧义
  • 名字说明的是效果和目的,而不是手段。
  • 可以通过先写测试程序后,后写处理的方式检查一下自己取的名字是否合适。
  • 名字要能念出来,除了便于现实对话之外,还能减轻阅读代码时大脑的负担
  • 名字要能搜索出来,名字如果是一个字母或一个数字,搜索时就会产生无数个结果,给代码的解析带来额外的负担。

这篇关于名字很重要的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

Linux Mint Xia 22.1重磅发布: 重要更新一览

《LinuxMintXia22.1重磅发布:重要更新一览》Beta版LinuxMint“Xia”22.1发布,新版本基于Ubuntu24.04,内核版本为Linux6.8,这... linux Mint 22.1「Xia」正式发布啦!这次更新带来了诸多优化和改进,进一步巩固了 Mint 在 Linux 桌面

如何评价Ubuntu 24.04 LTS? Ubuntu 24.04 LTS新功能亮点和重要变化

《如何评价Ubuntu24.04LTS?Ubuntu24.04LTS新功能亮点和重要变化》Ubuntu24.04LTS即将发布,带来一系列提升用户体验的显著功能,本文深入探讨了该版本的亮... Ubuntu 24.04 LTS,代号 Noble NumBAT,正式发布下载!如果你在使用 Ubuntu 23.

Cmake之3.0版本重要特性及用法实例(十三)

简介: CSDN博客专家、《Android系统多媒体进阶实战》一书作者 新书发布:《Android系统多媒体进阶实战》🚀 优质专栏: Audio工程师进阶系列【原创干货持续更新中……】🚀 优质专栏: 多媒体系统工程师系列【原创干货持续更新中……】🚀 优质视频课程:AAOS车载系统+AOSP14系统攻城狮入门视频实战课 🚀 人生格言: 人生从来没有捷径,只有行动才是治疗恐惧

研究生生涯中一些比较重要的网址

Mali GPU相关: 1.http://malideveloper.arm.com/resources/sdks/opengl-es-sdk-for-linux/ 2.http://malideveloper.arm.com/resources/tools/arm-development-studio-5/ 3.https://www.khronos.org/opengles/sdk/do

平时工作学习重要注意的问题

总体原则:抓住重点,条理清晰,可回溯,过程都清楚。 1 要有问题跟踪表,有什么问题,怎么解决的,解决方案。 2 要有常用操作的手册,比如怎么连sqlplus,一些常用的信息,保存好,备查。

matlab一些基本重要的指令

重点内容 运行MATLAB的帮助demo,在Command Window 输入 “demo”,或在Launch Pad 选项卡“demos” 任何时候都可以: 清除Command Window内容:clc 清除Figure Window(图形窗口) clf 清除workspace 变量内容: clear 注意:M脚本文件和输入指令中的变量都在workspace中,为避免变量冲突,一般在

Post-Training有多重要?一文带你了解全部细节

1. 简介 随着LLM学界和工业界日新月异的发展,不仅预训练所用的算力和数据正在疯狂内卷,后训练(post-training)的对齐和微调方法也在不断更新。InstructGPT、WebGPT等较早发布的模型使用标准RLHF方法,其中的数据管理风格和规模似乎已经过时。近来,Meta、谷歌和英伟达等AI巨头纷纷发布开源模型,附带发布详尽的论文或报告,包括Llama 3.1、Nemotron 340

C++数据结构重要知识点(5)(哈希表、unordered_map和unordered_set封装)

1.哈希思想和哈希表 (1)哈希思想和哈希表的区别 哈希(散列、hash)是一种映射思想,本质上是值和值建立映射关系,key-value就使用了这种思想。哈希表(散列表,数据结构),主要功能是值和存储位置建立映射关系,它通过key-value模型中的key来定位数组的下标,将value存进该位置。 哈希思想和哈希表数据结构这两个概念要分清,哈希是哈希表的核心思想。 (2)unordered

c++的名字空间

名字空间 什么是名字空间 在C语言中定义的全局变量、函数、结构、联合、枚举、枚举值、宏都在全局作用域下,所以当项目比较庞大时,非常容易造成命名冲突(以模块名作前缀、后缀),所以C++中选择把全局作用域进行拆分成 子作用域进行管理,这些子作用域就是作名字空间。 如何设计名字空间 namespace 空间名 {// 子作用域在该作用域中定义全局变量、函数、结构、联合、枚举、枚举值...,不

C++重要知识点拾忆

一:内联函数 函数调用也会带来降低效率的问题,因为调用函数实际上将程序执行顺序转移到函数所存放在内存中某个地址,将函数的程序内容执行完后,再返回到转去执行该函数前的地方。这种转移操作要求在转去前要保护现场并记忆执行的地址,转回后先要恢复现场,并按原来保存地址继续执行。 因此,函数调用要有一定的时间和空间方面的开销,于是将影响其效率。特别是对于一些函数体代码不是很大,但又频繁地被调用的函数