jQuery 代码风格
写代码不仅仅是让程序能跑起来,还要让代码清晰易读、方便维护。特别是在多人协作或者过一段时间你自己回头看的时候,一个统一、规范的代码风格显得尤为重要。
本篇文章会告诉你,在使用 jQuery 编程时应该遵循哪些代码风格和最佳实践,让你的代码更简洁、更专业,也更容易调试和维护。
统一使用 $
作为入口
在 jQuery 中,$
是最常用的函数入口。你应该统一使用 $
而不是 jQuery
来调用 jQuery 的方法:
✅ 推荐写法:
$('#menu').hide();
⛔ 不推荐写法:
jQuery('#menu').hide();
虽然两者功能相同,但 $
更简洁,也更常见。
变量命名规范
变量名应该清晰表达它的含义 ,避免随意命名。对于保存 jQuery 对象的变量,建议加上 $
前缀,以便和普通 DOM 对象区分。
✅ 推荐写法:
var $btnSubmit = $('#submit-button');
⛔ 不推荐写法:
var btnSubmit = $('#submit-button'); // 看不出这是 jQuery 对象
这样做可以让你一眼看出哪些变量是 jQuery 对象,避免误用。
链式调用要注意换行和缩进
jQuery 的很多方法支持链式调用,但当链太长时,为了可读性,你应该适当换行,并缩进对齐:
✅ 推荐写法:
$('#profile')
.addClass('active')
.css('color', 'red')
.fadeIn();
⛔ 不推荐写法:
$('#profile').addClass('active').css('color', 'red').fadeIn();
一行太长会影响阅读,换行之后也方便日后调试。