0%

变量命名缩写时的一些规律

有代码的地方就有变量,命名的好坏能影响到代码的可读性甚至是代码质量。有的变量或是方法名、类名会很长,需要缩写下,看起来用起来都方便。

有些单词有约定俗成的缩写,比如说message可以缩写为msgbutton缩写为btndescription缩写为desc。基本上是按音标,或是前几个字母来进行的。所以可以按这两种方式对变量进行缩写。缩写一般用3到5个字符,不用太短也不要太长。读音短的可以按变量中的重读字母来缩写,比如说amount可以缩写为amtclass缩写为cls。读音很多的,可以取前几个字母,比如说organization缩写为orginstitution缩写为instproduct缩写为prod等。

过度的使用缩写也会影响到代码的可读性,也有一些项目中所有变量都不使用缩写。我看过一些spring的源码,开始的时候被那长长的命名给吓到了,像FileSystemXmlApplicaionContextDefaultAdvisorAdapterRegistry之类的,但是一看就知道是什么意思,如果使用缩写可以写为FileSysXmlAppCtx这样的,写是方便了,但是可读性没有原来的好。

我认为对于缩写的使用,要有度,还要统一。一个项目中甚至一个公司内,可把使用到的变量缩写统一管理起来,代码中只准使用规定好的,这样就可以做到每个人代码中的变量都不会有岐义。不光是缩写,所有的命名都可以统一管理起来,用的时候优先使用规定好的。