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


Posted in Javascript onFebruary 03, 2017

最近学了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编写的规范。希望本文的内容对大家的学习或者工作能带来一定的帮助,同时也希望多多支持三水点靠木!

Javascript 相关文章推荐
jquery 实现密码框的显示与隐藏示例代码
Sep 18 Javascript
js取整数、取余数的方法
May 11 Javascript
JavaScript模版引擎的基本实现方法浅析
Feb 15 Javascript
jquery html5 视频播放控制代码
Nov 06 Javascript
jQuery操作复选框(CheckBox)的取值赋值实现代码
Jan 10 Javascript
Vue中定义全局变量与常量的各种方式详解
Aug 23 Javascript
vue实现树形菜单效果
Mar 19 Javascript
vue如何通过id从列表页跳转到对应的详情页
May 01 Javascript
一百行JS代码实现一个校验工具
Apr 30 Javascript
element-ui中按需引入的实现
Dec 25 Javascript
vant 中van-list的用法说明
Nov 11 Javascript
JS代码实现页面切换效果
Jan 10 Javascript
Javascript for in的缺陷总结
Feb 03 #Javascript
canvas绘制七巧板
Feb 03 #Javascript
JS对象是否拥有某属性如何判断
Feb 03 #Javascript
jQuery实现的浮动层div浏览器居中显示效果
Feb 03 #Javascript
JavaScript中捕获与冒泡详解及实例
Feb 03 #Javascript
JS基于正则截取替换特定字符之间字符串操作示例
Feb 03 #Javascript
几种tab切换详解
Feb 03 #Javascript
You might like
怎么使 Mysql 数据同步
2006/10/09 PHP
PHP添加MySQL数据记录代码
2008/06/07 PHP
PHP实现获取中英文首字母
2015/06/19 PHP
php实现每日签到功能
2018/11/29 PHP
PHP判断是否微信访问的方法示例
2019/03/27 PHP
PHP7变量处理机制修改
2021/03/09 PHP
克隆javascript对象的三个方法小结
2011/01/12 Javascript
使用jQuery实现的网页版的个人简历(可换肤)
2013/04/19 Javascript
通过js为元素添加多项样式,浏览器全兼容写法
2014/08/30 Javascript
Js可拖拽放大的层拖动特效实现方法
2015/02/25 Javascript
JavaScript中诡异的delete操作符
2015/03/12 Javascript
JavaScript必知必会(七)js对象继承
2016/06/08 Javascript
一个例子轻松学会Vue.js
2017/01/02 Javascript
nodejs爬虫遇到的乱码问题汇总
2017/04/07 NodeJs
判断颜色是否合法的正则表达式(详解)
2017/05/03 Javascript
JavaScript设计模式之单例模式详解
2017/06/09 Javascript
修改vue+webpack run build的路径方法
2018/09/01 Javascript
通过扫小程序码实现网站登陆功能
2019/08/22 Javascript
js实现3D旋转效果
2020/08/18 Javascript
Vue循环中多个input绑定指定v-model实例
2020/08/31 Javascript
利用Vue实现简易播放器的完整代码
2020/12/30 Vue.js
Python使用matplotlib绘图无法显示中文问题的解决方法
2018/03/14 Python
python程序快速缩进多行代码方法总结
2019/06/23 Python
使用apiDoc实现python接口文档编写
2019/11/19 Python
使用TensorFlow搭建一个全连接神经网络教程
2020/02/06 Python
HTML5 Canvas 起步(1) - 基本概念
2009/05/12 HTML / CSS
html5使用canvas画一条线
2014/12/15 HTML / CSS
致铅球运动员加油稿
2014/02/13 职场文书
教师党员公开承诺事项
2014/05/28 职场文书
小学“向国旗敬礼”网上签名寄语活动总结
2014/09/27 职场文书
庆祝三八妇女节标语
2014/10/09 职场文书
2014年评职称工作总结
2014/11/20 职场文书
2014年医院党建工作总结
2014/12/20 职场文书
部队个人年终总结
2015/03/02 职场文书
公司财务经理岗位职责
2015/04/08 职场文书
php+laravel 扫码二维码签到功能
2021/05/15 PHP