📜  js 命名约定 - Javascript (1)

📅  最后修改于: 2023-12-03 15:32:22.805000             🧑  作者: Mango

JS命名约定 - Javascript

Javascript是一种脚本语言,它的命名约定是一种比较重要的规范。遵循约定可以使代码更加易于阅读,可维护性更高。下面是一些常用的JS命名约定:

变量命名
使用小驼峰式命名

变量名应该由一个或多个单词组成,并使用小驼峰式命名法(第一个单词小写,后面的单词首字母大写)。这使变量名更易于阅读,并在IDE中使用自动补全时更方便。

let myVar = 'some value';
使用有意义的名称

变量名应该是有意义的,具有描述性,以便其他开发人员可以理解代码的用途。避免使用难以理解的名称或缩写。

let numberOfWidgets = 10;
避免使用JavaScript关键字

避免使用JavaScript的保留关键字作为变量名。这些关键字包括 varletconstclassfunction等等。

使用常量时,使用大写字母和下划线

常量应该由一个或多个大写字母和下划线组成。这使常量在代码中更容易区分。常量应该在程序的开头定义,并在整个程序中使用。

const MAX_LENGTH = 10;
函数命名
函数名应该以动词开头

函数名应该以动词开头,以表明函数执行的操作。避免使用无意义的函数名。

function calculateTotal() {
 // some code here
}
使用小驼峰式命名法

函数名应该使用小驼峰式命名法,以使代码具有一致的风格。

function calculateTotal() {
 // some code here
}
避免使用JavaScript关键字

避免使用JavaScript的保留关键字作为函数名。这些关键字包括 varletconstclassfunction等等。

类命名

类名应使用大驼峰式命名法(每个单词的首字母都大写)。类名应该清楚地表明它们所代表的类型。

class Car {
  // some code here
}
DOM元素命名
使用语义化的名称

使用语义化的名称可以更清楚地表达DOM元素的用途。

<button id="submitBtn">Submit</button>
使用BEM命名约定

BEM命名约定是一种流行的命名约定,它可以更清晰地定义DOM元素,使它们更易于阅读和理解。

<div class="block__element--modifier"></div>
总结

遵循JS命名约定可以使代码更易于阅读和维护。变量和函数应该使用小驼峰式命名法,常量应该使用大写字母和下划线,类名应该使用大驼峰式命名法。DOM元素应该使用语义化的名称并遵循BEM命名约定。遵循这些规则可以使代码更具一致性,易于理解和维护。