代码大全2 变量名的力量
作者:@kuaiquxie
作者的github:https://github.com/bitebita
本文为作者原创,如需转载,请注明出处:https://www.cnblogs.com/dzwj/p/15750406.html
什么是变量名呢,简单地描述,还是对变量的描述,清楚的对变量的描述,用完整的变量名降低冲突。
为变量赋予主要含义的,一般放在最前面,这样显得突出,将Totol,Sum,Average,这些限定词放在最后面,这样一致的话,即可以提高代码可读性,又可以很好的去做维护工作,但是这里有一个限定词是约定俗成的,那就是Num,peopleNum代表的是人员的特定序号,numPeople代表的是人员总数。这样有时候会很麻烦,建议将总数换成Count,将特定序号换成Index,这样好管理。在进行变量命名时, 多用对仗词,比如begin/end等等以此来增加可读性。
那么为特定的数据类型命名呢,我们常使用的循环变量,状态变量,临时变量,布尔变量,枚举类型,具名常量这些就不能随意去命名,需要给他们一个完整的含义,记住你写的代码是给别人看的,别人能看得懂你用i,j,k这些字母命名的循环变量吗,虽然有时候能够猜到,但是代码是直观体现内容的,就应该一看就懂这是什么含义,所以为这些变量,常量赋以完整的含义吧。
在相应的布尔变量上也需要采用这样的变量命名,以增加可读性,有的人习惯在变量前加上Is,这样有时候确实很方便,但是在有些逻辑表达式中就显得可读性很差,比如if(isFound) 这个表达式就显得有歧义,这时候就用found就可以了。
在进行枚举类型变量命名的时候,加上一些前缀就好很多,比如年月日,year_,month_,day_,加上这样一些前缀是不是想要表达的意思就很明显。
编程的命名规则可以对你所用的编程语言给予相应的弥补,就好比你在为员工写一些类属性的时候,前面加上employee,这样就将这些员工的属性相关联起来了,尽早采用适当的命名规则对以后的项目编写,对以后将你的项目交给其他人的时候,这时候你就会看到命名规则的重要性了,当然这在大项目上体现的很明显。
通过在变量前面加前缀这种能够很好的区分各种类型变量,比如在全局变量前加上g_,在局部变量前加上m_,在常量前加上c_,前面说了一些前缀,那么前缀的标准是什么呢,有以下两种:
对于一些已经标准化的命名,命名时就不用再去想了,标准化的前缀优点是使名字变得更加紧凑,准确的对类型做出判断,但是这样的话也是有些瑕疵的,因为已经有标准的命名了,就不会去想一些有意义的名字了。
有效的命名规则对于阅读者阅读代码很有帮助。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
· Linux系列:如何用heaptrack跟踪.NET程序的非托管内存泄露
· 开发者必知的日志记录最佳实践
· winform 绘制太阳,地球,月球 运作规律
· AI与.NET技术实操系列(五):向量存储与相似性搜索在 .NET 中的实现
· 超详细:普通电脑也行Windows部署deepseek R1训练数据并当服务器共享给他人
· 上周热点回顾(3.3-3.9)
· AI 智能体引爆开源社区「GitHub 热点速览」