如何选择好的变量名！

Posted 2021-02-27 teclado

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了如何选择好的变量名！相关的知识，希望对你有一定的参考价值。

一个好的变量名能够完全的，准确的表达所代表的事物。

能否命名出好的变量名对于一个程序的可读性和维护性而言至关重要。

变量的命名如此重要，但对于很多初学者来说并不重视，带有一些随意的心态命名变量，如果养成不正确的习惯会让之后的学习变得更艰难。

本次将整理一些有用的变量命名方法提供给大家参考：

基本技巧

一. 变量名应尽量用文字表述清楚，要求没有歧义并且完整，可以通过名字快速了解到事物的本质。而且名字不宜过长或过短。

x,x1,x2;   //是坏名字，无法理解变量表示的含义
date;      //是坏名字，这里的日期的包括所有日期，意义并不准确
todaydate; //表示当前日期，可以快速明白含义

二. 约束变量名的长度，名字太短会增加理解难度或者语义混乱，太长会让代码行变得冗余。所以适当约束长度会让程序解读和维护更高效，毕竟变量名的好坏对别人解读代码的影响更大。

研究表明，变量名长度在10-16个字符时，调试程序花费的气力是最小的，

numberOfPeopleOnTheOlympicTeam;    //过长

n,bp,nst,max;                      //过短

teamPointsMax，pointsRecord;       //正好

三. 计算限定词后置,变量命名时会遇到表示计算结果的变量:总额, 平均值, 最大值等,那么应该把 Total , Sum , Max , Min 等放在要修饰的名字后面,并且形成这样的习惯,避免程序中出现 totalRevenue 和 revenueTotal 产生的歧义。

revenueTotal     ,     espenseTotal     ,    revenueAverage   ,    expenceAverage 

totalRevenue     ,     totalEspense     ,    averageRevenue   ,    averageExpense   //很容易看出上一行更符合编码的习惯

四. 准确的使用对仗词，命名时遵守对仗词的命名规则有助于保持一致性，从而提高可读性。下面列出常用的一些对仗词：

open/close        begin/end      show/hide      create/destroy    
lock/unlock       first/last     min/max        start/stop     
get/put           uo/down        old/new        source/target

五. 谨记典型的布尔变量名，，给布尔变量赋予隐含“真/假”含义的名字。例如 done , error , found ,success 等

六. 区别变量名和子程序名字，变量名以小写字母开头，子程序用大写字母开头。例如 variableName 对 RoutineName 。

七. 区别类与对象的名字，下面有几种标准方案：

* 通过大写字母开头区分类型和变量 ------ Widget 和 widget ， LongerWidget 和 longerWidget 。

* 通过加“t-”前缀区分类型和变量 ------- t-Widget 和 Widget ， t-LongerWidget 和 LongerWidget 。

* 通过给变量加“a”前缀区别类型和变量------- Widget 和 aWidget ， LongerWidget 和 aLongerWidget 。

* 通过对变量采用更明确的名字区分类型和变量------- Widget 和 employeeWidget ， LongerWidget 和 fullEmployeeWidget 。

八. 标识全局变量，可在全局变量名之前加“g-”，那么当读到这个变量就会很清楚知道这是个全局变量，例如 g-RuningTotal , g-ColorPointer 。

九. 标识成员变量，要求能够名字识别出变量是类的数据成员，可在成员名字前加“m-”，；例如 m-ClassVariable , m-Velocity 。

十. 标识具名常量，通常在常量名前加“c-”，而在C中则是全为大写，例如 c-ReceaMax , RECESMAX 。

十一. 利用格式化命名提高可读性，常用是以下俩字方法：

* 利用大小写来分隔单词，例如 PointerTotal , InvalidFirst 。