返回

前后缀助力清晰命名类函数变量,让代码可读性更上一层楼

前端

许多程序员总是抱怨自己写的代码和屎一样,可当别人读他的代码时,却惊叹于代码的精妙。这就是命名法则在发挥作用,好的命名法则能够让你的代码更加具有可读性,降低代码理解的成本,提高程序的维护成本。而A/HC/LC命名法则是一个十分好用的命名法,能够让你的代码清晰易读,可读性更加出色。

何谓A/HC/LC命名法

A/HC/LC命名法是由前缀(Prefix)、核心(Head)、类别(Category)和后缀(LC)四个部分组成的,而我们现在使用的大多数编程语言都支持这种命名方式。例如,在JavaScript中,你可以使用点号(.)和方括号([])来访问对象和数组的属性,使用引号(“”)或反引号(``)来定义字符串,使用圆括号(())来调用函数,等等。这些都是A/HC/LC命名法的基本组成部分。

A/HC/LC命名法的使用

  1. 前缀(Prefix) :前缀通常用于标识一个函数或变量的作用域或类型。例如,在JavaScript中,你可以使用_来表示私有变量,$来表示全局变量,this来表示当前对象,等等。使用前缀可以帮助你快速识别一个函数或变量的用途和范围,从而提高代码的可读性和可维护性。

  2. 核心(Head) :核心通常用于标识一个函数或变量的名称。例如,在JavaScript中,你可以使用length来标识一个字符串的长度,push来标识一个数组的添加元素方法,等等。使用核心可以帮助你快速了解一个函数或变量的具体作用,从而提高代码的可读性和可维护性。

  3. 类别(Category) :类别通常用于标识一个函数或变量的类型或用途。例如,在JavaScript中,你可以使用Array来标识一个数组,Object来标识一个对象,String来标识一个字符串,等等。使用类别可以帮助你快速识别一个函数或变量的类型或用途,从而提高代码的可读性和可维护性。

  4. 后缀(LC) :后缀通常用于标识一个函数或变量的单位或格式。例如,在JavaScript中,你可以使用px来标识一个像素值,%来标识一个百分比值,等等。使用后缀可以帮助你快速识别一个函数或变量的单位或格式,从而提高代码的可读性和可维护性。

A/HC/LC命名法的优势

  1. 提高代码的可读性 :A/HC/LC命名法可以帮助你编写出更加清晰易读的代码。通过使用前缀、核心、类别和后缀,你可以快速识别一个函数或变量的作用域、类型、用途和单位,从而降低代码理解的成本,提高程序的维护成本。

  2. 提高代码的可维护性 :A/HC/LC命名法可以帮助你编写出更加容易维护的代码。通过使用清晰易懂的命名,你可以快速找到需要修改的代码,从而降低代码维护的成本,提高程序的稳定性。

  3. 提高代码的可重用性 :A/HC/LC命名法可以帮助你编写出更加容易重用的代码。通过使用清晰易懂的命名,你可以快速识别一个函数或变量的作用,从而将其轻松地应用到其他项目中,提高代码的重用性,降低代码开发的成本。