命名约定 - JS中的HTML元素

时间:2011-05-11 07:11:20

标签: javascript html naming-conventions

如何在JS中命名HTML元素对象?

var divEditorArea = document.getElementById("editorarea");

var btnCheckSyntax = document.getElementById("checksyntax");

这是一个好方法吗?

2 个答案:

答案 0 :(得分:1)

据我所知,JS中没有用于命名HTML元素的约定。 Javascript是一个多元化的世界,即使有一个约定,它也很难被大多数社区所遵循。例如,请参阅各种代码链接和代码样式约定(https://www.sitepoint.com/comparison-javascript-linting-tools/)。

名称应清楚地显示您的意图,以便代码易于理解。我不认为为了清晰起见而将HTML元素的类型添加到JS变量名称中有很多用处(例如,&bbspn'和#39;在你的例子中) ,但有可能会增加清晰度。而且,如果你是一个团队,你可能应该遵循团队的惯例。

使用您的最佳判断力,始终努力使代码更加清晰。

答案 1 :(得分:0)

如果您使用香草JS,如Vinicius所言,则没有为HTML DOM元素命名JS变量的约定。

我将其命名为:

let elCheckSyntax = document.querySelector("#checksyntax");

OR

let elementEditorArea and elementCheckSyntax

另一种方法是某些团队希望在DOM元素前添加$。因此,一旦团队中的任何人看到带有$前缀的任何变量,他们就会知道这是一个DOM元素。

像这样

let $editorArea;
let $checkSyntax;

因此,独立工作和团队的命名约定完全取决于您的方便