jquery代码规范让代码越来越好看

更新时间：2017年02月03日 15:22:33 作者：单先生

本文主要介绍了jquery的代码规范。具有很好的参考价值，下面跟着小编一起来看下吧

最近学了jQuery,感觉这个jQuery是真的挺不错的，果然像他说的那样，少些多做！刚一入手感觉真是不错。但是写多了，就会发现这个代码一行居然能写那么长。而且可读性还不好。有幸自己买了一本锋利的jQuery这本书。我就整理了下。到底在实际应用中怎么让自己的jQurey的代码看起来可读性强，而且还有美感。我就用了了本书中的一个小例子。来教教大家代码应该怎么写菜好看！

废话不多说，想把这个demo代码奉上。各位爷！您瞧好啊~

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>菜单栏</title>
 <style>
 *{
  margin: 0;
  padding: 0;
 }
 .box{
  width: 400px;
  height: 280px;
  background-color: red;
  margin: 50px auto;
  border: 1px solid #000;
 }
 .box .menu{
  width: 100%;
  height: 100%;
  background-color: gold;
  list-style: none;
 }
 .box .menu>.level1{
  width: 100%;
  height: auto;
  line-height: 40px;
  list-style: none;
 }
 .box .menu>.level1>a.current{
  background-color: green;
  color: #0a0a0a;
  text-decoration: none;
 }
 .box .menu>.level1>a{
  display: inline-block;
  background-color: gray;
  width: 100%;
  text-align: center;
  text-decoration: none;
 }
 .box .menu>.level1>.level2{
  width: 100%;
  height: 160px;
  background-color: white;
  display: none;
  float: left;
 }
 .box .menu>.level1:nth-of-type(1)>.level2{
  display: block;
 }
 .box .menu>.level1>.level2 li{
  width: 100%;
  height: 40px;
  list-style: none;
  background-color: gainsboro;
  text-align: center;
 }
 </style>
 <script src="http://libs.baidu.com/jquery/1.9.1/jquery.min.js"></script>
 <script>
 $(function () {

  $(".level1>a").click(function () {
  $(this).addClass("current").next().show().parent().siblings().children("a").removeClass("current").next().hide();
  return false;
  });
 });
 </script>
</head>
<body>
<div class="box">
 <ul class="menu">
 <li class="level1">
  <a href="#one" class="current">衬衫</a>
  <ul class="level2">
  <li>短袖衬衫</li>
  <li>长袖衬衫</li>
  <li>短袖衬衫</li>
  <li>短袖衬衫</li>
  </ul>
 </li>
 <li class="level1">
  <a href="#one">卫衣</a>
  <ul class="level2">
  <li>开襟卫衣</li>
  <li>开襟卫衣</li>
  <li>开襟卫衣</li>
  <li>开襟卫衣</li>
  </ul>
 </li>
 <li class="level1">
  <a href="#one">裤子</a>
  <ul class="level2">
  <li>短袖衬衫</li>
  <li>裤子衬衫</li>
  <li>短袖衬衫</li>
  <li>裤子衬衫</li>
  </ul>
 </li>
 </ul>
</div>
</body>
</html>

童鞋们。请看这段代码

 $(".level1>a").click(function () {
  $(this).addClass("current").next().show().parent().siblings().children("a").removeClass("current").next().hide();
  return false;
  });

请问你第一眼看着个你能一下子看明白是怎么回事吗？

哪怕是开发过几年的大神。也不能一眼就看出来这行代码要干啥。就是因为这行代码太长了。每读一次都要自讲前面的串联起来看。毫无美感，阅读性。

虽然jQuery做到了行为和内容的分离，但jQuery代码也应该拥有良好的层次结构机规范，这样才能进一步改善代码的可读性和可维护性。

所以代码应该写出这种样式

 $(".level1>a").click(function () {
  $(this).addClass("current")
  .next().show()
  .parent().siblings().children("a").removeClass("current")
  .next().hide();
  return false;
  });

将每一次对象执行的动作分割成单独一行。这样可读性就大大提高了。

但也不要随意分割，随意分割那你还不如分割呢。所以总结了，以下三点

1.对于同一个对象不超过3个操作的，可以直接写成一行

$(this).addClass("current").show();

2.对于同意对象的较多操作建议，每行写一个操作

 $(this).addClass("current")
  .show()
  .fadeTo("mouseover")
  .fadeTo("fast",1)
  .unbind("click")
  .click(function(){
  //do something
  });

3.对于多个对象的少量操作，可以每一个对象写一行，如果涉及子元素，可以考虑适当的缩进，例如demo中的代码

$(this).addClass("current")
  .childer("li").show().end()
.siblings().removeClass()
  .children("a").hide();

还要强调一点，就是要为代码添加注释；

jQuery 以其强大的选择器著称，有时候很复杂的问题用一行选择器就可以轻松解决，但是很容易写出来下面的代码

$("#table>tbody>tr:has(td:has(:checkbox:enabled))").css("background","red"); 哈哈，你能一眼认出来我吗？

在编写一个优秀的选择器的时候，千万不要忘记给这一段代码加上注释，这很重要，无论是自己日后阅读还是与他人分享、合作开发，注释都能起到良好的效果

//注释：在一个id为table的表格的tbody中，如果每一行的一列中的checkbox没有被禁用，则把这行的背景设为红色
$("#table>tbody>tr:has(td:has(:checkbox:enabled))").css("background","red");

通过类似的有意义的注释，能够培养良好的编码习惯和风格，提高开发效率。

----------------------------------------------------------更新---------------------------------------------------------

（1）jQuery对象和DOM对象的相互转换

在jQuery对象和DOM对象相互转换之前，先约定好定义变量的风格，如果获取的对象是jQuery对象，那么在变量面前加上$

例如：

var $variable = jQuery对象

如果获取的DOM对象；

var varible = DOM对象；

以上是jQuery编写的规范。希望本文的内容对大家的学习或者工作能带来一定的帮助，同时也希望多多支持脚本之家！

您可能感兴趣的文章:

jquery

jQuery实现瀑布流布局详解（PC和移动端）
这篇文章非常全面的介绍了在PC和移动端上jQuery实现瀑布流布局的详细过程，文中示例代码介绍的非常详细，具有一定的参考价值，对瀑布流布局感兴趣的小伙伴们可以参考一下
2015-10-10
JQuery 动画卷页返回顶部动画特效(兼容Chrome)
JQuery 动画卷页返回顶部动画特效(兼容Chrome) ,学习jquery的朋友可以测试下。
2010-02-02
无法获取隐藏元素宽度和高度的解决方案
本文主要介绍了无法获取隐藏元素（display:none）宽度(width)和高度(height)的解决方案，具有很好的参考价值。下面跟着小编一起来看下吧
2017-03-03
基于jQuery UI CSS Framework开发Widget的经验
jQuery UI CSS Framework是jQuery UI中的一个样式框架，可以利用jQuery Theme roller 来生成自己想要的css样式效果。我们可以利用jQuery UI的一些框架来开发出基于jQuery UI CSS Framework效果的插件来。
2010-08-08
jQuery访问浏览器本地存储cookie、localStorage和sessionStorage的基本用法
cookie，localStorage和sessionStorage都是浏览器本地存储数据的地方,其用法不尽相同，今天小编通过本文给大家分享jQuery访问浏览器本地存储cookie、localStorage和sessionStorage的基本用法，需要的朋友参考下吧
2017-10-10
jquery中push()的用法(数组添加元素)
这篇文章主要介绍了jquery的push使用方法，可向数组的末尾添加一个或多个元素，并返回新的长度,需要的朋友可以参考下
2014-11-11
JQuery入门——用bind方法绑定事件处理函数应用介绍
bind()功能是为每个选择元素的事件绑定处理函数,感兴趣的你可以了解下它的语法bind(type, [data], fn),参数data是作为event.data属性值传递对象的额外数据对象,好好学习希望本可以帮助到你
2013-02-02
jQuery随机密码生成的方法
这篇文章主要介绍了jQuery随机密码生成的方法,实例分析了jQuery操作随机数的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-03-03
jQuery操作CSS样式
这篇文章介绍了jQuery操作CSS样式的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-03-03
jQuery的三种$()
$号是jQuery“类”的一个别称，$()构造了一个jQuery对象。所以，“$()”可以叫做jQuery的构造函数（个人观点，呵呵！）。
2009-12-12