【C#】如何给变量取一个好的名字
讲一讲如何对变量命名。
以下是本文的目录大纲:
一. 变量命名风格
二. 变量命名最高境界
三. 变量命名最佳实践
一.变量命名风格
变量命名风格通常会根据不同的变量类型来区分,以Java语言为例,根据变量类型不同有两种命名风格:
1)类成员变量、局部变量
类成员变量、局部变量通常采用驼峰命名风格,如下:
String userName;
2)静态成员变量、枚举值、常量
静态成员变量、枚举值、常量通常采用所有字母大写、多个单词以英文下划线连接,如:
public static final int MAX_YEARS = 25;
// 建议枚举类都以Enum结尾
enum ColorEnum {RED(0, "红色"),YELLOW(1, "黄色"),GREEN(2, "绿色"),WHITE(3, "白色"),BLACK(4, "黑色");private int code;private String name;Color(int code, String name) {this.code = code;this.name = name;}
}
二.变量命名最高境界
在函数命名那篇中我们说的函数命名最高境界是见字如面,那么对于变量命名来说,最高境界是什么呢?我认为是:自解释,即"代码即注释"。
为什么这么说呢,因为通常来说一个函数是会有函数注释的,即使函数名字取的不好,如果注释写的比较清楚,对于后续维护人员来说也是了解函数具体功能的一种方式。
而变量则不同,在一个工程里面,变量的数量远远大于函数的数量,所以不太可能对于每个变量都去写注释,所以如果一个工程的变量命名很糟糕,那么对于后续维护人员来说将是毁灭性的打击,因为每读到一个变量,可能就需要去猜测变量的含义,我想没有哪个人愿意读到这样的代码,永远记住一点:“代码是写给人看的,不是写给机器看的”。
譬如下面这段代码的命名就非常糟糕:
ppn = (cpn > 1) ? (cpn - 1) : cpn;
npn = (cpn < tpn) ? (cpn + 1) : tpn;
p = new Page(ppn, cpn, npn, tpn);
上面这段代码估计只有原作者清楚地知道各个变量的含义是啥了,
如果修改为下面这种写法,可读性会好很多,并且一目了然,很容易知道其大概意图是计算分页信息:
prePageNum = (curPageNum > 1) ? (curPageNum - 1) : curPageNum;
nextPageNum = (curPageNum < totalPageNum) ? (curPageNum + 1) : totalPageNum;
page = new Page(prePageNum, curPageNum, nextPageNum, totalPageNum);
三.变量命名最佳实践
1)采用名词或者形容词来命名变量
变量一般情况下建议使用名词、名字组合或者形容词,因为变量一般形容的是一种事物或者事物的属性,所以用名词或者名词组合更容易让人理解,而形容词一般用于bool类型的变量。
2)避免使用单字母变量,尽量细化变量含义
在程序中,尽量避免使用单字母变量,唯一可以接受使用单字母变量的场景只有for循环,不过还是不太推荐在for循环中使用单字母变量(用pos、index比for循环的i、j、k要好很多)。
举个例子,比如下面这行代码:
double calConeVolume(double b, double d) {return Math.PI * b * b * d / 3;
}
咋一看这个函数参数感觉挺清晰,但是一细看,b是什么?d又是什么?如果我要用这个函数,该怎么传参?估计大部人是一脸懵逼状,只能进去看实际的函数实现才知道b是圆锥体半径,d是圆锥体高度;
那么怎么优化这段代码命名呢?其实很简单,稍微细化一下变量含义,让变量名自己去表达实际意图:
double calConeVolume(double radius, double height) {return Math.PI * radius * radius * height / 3;
}
3)变量命名前后用词需统一
在同一个工程或者一个场景下,变量命名风格需前后统一,比如total和sum都能表示总计的意思,那么所有需要用到"总计"含义的地方要么全部使用total、要么全部使用sum。
保持前后命名风格统一是保证工程代码良好可读性的关键保证。
4)集合变量用类型或者复数s作为后缀
在java中,有很多集合,比如List、Map、Set等,那么集合变量该怎么命名呢?
一般可采取两种方式:
- 使用复数s结尾
List students = new ArrayList<>(); - 用集合类型作为后缀
List studentList = new ArrayList<>();
上面两种方式均可,没有比较明显的偏好,根据实际场景决定。第一种方式相对更简洁,第二种在局部作用域里面有多种相关的集合变量时区分度更大,比如:
List<Student> studentList = new ArrayList<>();
Map<Long, Student> studentMap = Maps.newHashMap();
for (Student stu : studentList) {studentMap.put(stu.getId, stu);
}
我的建议是如果局部作用域只有一种类型的集合,那么推荐使用复数形式;如果局部作用域有多个相关的集合类型,那么推荐用类型结尾。
5)禁止使用is作为bool类型的类成员变量前置
在java中,禁止用is作为bool类型的类成员变量的前缀,因为is作为前缀会导致序列化/反序列出现问题,阿里的java代码规范中也明确提到了这一点,所以在写代码的时候最好还是遵守公认的规范,不然哪天说不定就踩坑了。
6)尽量避免使用缩写进行命名
有些时候,变量名可能有点长,不利于代码可读性,因此很多时候在写代码的时候喜欢用缩写来命名,但这个不是一个好的习惯,除非使用的缩写是大家都会使用的约定俗称的缩写。
比如下面这个命名:
int averageStudentAge; => int avgStudentAge;
因为avg大家都知道是average的缩写,所以这么写问题不大,不会引起歧义;
但是下面这种缩写命名:
res
tmp
cnt
就不是好的缩写命名,因为不同的人阅读可能会有不同的理解:
res => response、resource、result
tmp => temporary、template
cnt => count、content、context
附上一些约定俗称的缩写:
全称 | 缩写 |
---|---|
identification | id |
average | avg |
maximum | max |
minimum | min |
buffer | buf |
error | err |
message | msg |
image | img |
length | len |
library | lib |
password | pwd |
position | pos |
data transfer object | dto |
view object | vo |
7)抛弃掉flag变量
国内一些早期的教材上,到处充斥着各种flag风格的变量,这种命名方式对于大型工程简直就是噩梦,比如:
int flag = getDoctorFlag(doctorId);
if (flag == 1) {//....
}
看到这段代码,读者会有疑问flag变量的含义是什么?flag值为1的时候又代表什么含义?是医生的值班/在岗状态、还是医生的身体状态?估计读者的内心是崩溃的。
如果优化成下面这种形式:
DutyStatus doctorDutyStatus = getDoctorDutyStatus(doctorId);
if (doctorDutyStatus == DutyStatus.ONLINE) {// ...
}
就比上面的形式清晰多了,很容易看出来判断的是医生的值班/在岗状态。
【C#】如何给变量取一个好的名字相关推荐
- 工程实践:如何给变量取一个好的名字
工程实践:如何给变量取一个好的名字 在上一篇文章中跟大家分享了关于函数命名的一些实践心得,今天我们继续命名这个话题,来讲一讲如何对变量命名. 以下是本文的目录大纲: 一. 变量命名风格 二. 变量命名 ...
- 给函数和变量取一个有意义的名字
为什么要给函数和变量取一个有意义的名字? 1. 代码写出来是给以后的自己和别人看的,易于理解的变量名可以更好的阅读,并且可以看出编码者的个人修养和编程功底: 2. 好的变量名字有利于提高自己英语水平( ...
- wpf中使用控件时,最好给控件取一个好的名字
wpf中使用控件时,最好给控件取一个好的名字, 比如按钮A可以 取名为 btnA 这样使用会是编程清晰.
- 给数据库表列取一个好的名字
做父母的总希望给自己的子女取一个响亮的.富有含义的名字.有时候家长为了找到一个合适的名字,会拿起平时碰都不碰的汉语大辞典翻个好几天.天下父母心呀.其实在数据库中创建对象时,管理员也要对其进行命名. 其 ...
- 教你如何给孩子取一个好名字!
古语有云:"赐子千金,不如教子一艺:教子一艺,不如赐子好名."可谓道出了姓名对人的重要性.那么,作为父母如何给孩子起一个大富大贵.提升运势的名字呢? 首先,须以孩子的生辰八字取用神 ...
- 技术图文:如何爬取一个地区的气象数据(下)?
背景 架空线路常见的故障有:风偏闪络故障.雷击跳闸故障.雷击断股故障.线路覆冰故障.线路污闪故障.线路外力破坏故障.线路鸟害故障等等.从这些故障中,我们可以看出天气对线路的安全运行起到非常重要的作用. ...
- mysql查询每个id的前10条数据_解决 MySQL 比如我要拉取一个消息表中用户id为1的前10条最新数据...
我们都知道,各种主流的社交应用或者阅读应用,基本都有列表类视图,并且都有滑到底部加载更多这一功能, 对应后端就是分页拉取数据. 好处不言而喻,一般来说,这些数据项都是按时间倒序排列的,用户只关心最新的 ...
- tidyr | 变量取值组合、缺失值处理、变量分列与合并
关于tidyr工具包已经有三篇推文了,详情可查看本号推文索引.本篇来介绍该包剩余的其他函数. tidyr工具包的功能是使数据更加整洁,多配合dplyr工具包进行数据预处理,其包含的函数并不多,除已经介 ...
- Project2 分段切割路面,只取一个种子点
分段切割路面,只取一个种子点 #include <pcl/visualization/cloud_viewer.h> #include <iostream>//标准C++库中的 ...
最新文章
- javascript this用法小结
- SAP 预算控制业务集成
- 树莓4派开机动画_树莓派4+无屏幕安装系统+ssh远程+远程桌面
- SSDT表的遍历(源码)
- java ee的小程序_在Java EE应用程序中实现自动重试
- Ubuntu搭建联盟链,实现节点之间数据同步
- Ceph OSD处理客户端写操作处理流程
- 软件测试工程师面试-常见的python笔试题(一)
- Skyline软件二次开发初级——6如何在WEB页面中的三维地图上进行坐标和方向计算...
- 少年张三丰java版_长这么大才知道,《少年张三丰》有两个版本,更喜欢哪一个版本...
- fedora15 一些简单应用
- 用两种while循环求2的n次方,n是传入的值。
- 计算机桌面背景显示方式有几种,如何让计算机自动更改桌面背景
- Unity策略游戏集合
- 微信尝试刷掌支付;苹果 WWDC 将于 6 月 6 日开幕;Qt Creator 10 发布|极客头条
- Unity (游戏引擎)
- 使用matlab对一维矩阵的数据进行滤波
- oracle lag over 用法,lag()使用方法
- 利用java输出一个月的日历表
- Cobalt编译流程分析
热门文章
- 高手必备 | Revit插件到底哪个好?区别是什么?
- 签个到,哎,下午的数值计算可以考的好点的。。。。忧桑。。。
- 彼得.得鲁克与因果定律
- authconfig‐tui_openldap(3)linux 、ldap、sssd 认证
- 基于javaweb的图书管理系统(java+jsp+layui+bootstrap+servlet+mysql)
- 【缓存】@CacheEvict
- SpringCache的简单入门(RedisCacheManager)(@Cacheable、@CachePut、@CacheEvict)
- 【论文解读】(如何微调BERT?) How to Fine-Tune BERT for Text Classification?
- 利用ajax从jsp中返回的字符串时出现回车符号解决办法
- EventBus原理源码分析和使用