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 相关文章推荐
javascript动画浅析
Aug 30 Javascript
js 一个关于图片onload加载的事
Nov 10 Javascript
javascript客户端遍历控件与获取父容器对象示例代码
Jan 06 Javascript
JS对字符串编码的几种方式使用指南
May 14 Javascript
jQuery检查事件是否触发的方法
Jun 26 Javascript
Jquery实现仿京东商城省市联动菜单
Nov 19 Javascript
基于socket.io+express实现多房间聊天
Mar 17 Javascript
原生js实现鼠标跟随效果
Feb 28 Javascript
分析JS单线程异步io回调的特性
Dec 01 Javascript
vue 实现类似淘宝星级评分的示例
Mar 01 Javascript
Javascript实现秒表计时游戏
May 27 Javascript
Vue3配置axios跨域实现过程解析
Nov 25 Vue.js
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
PHP COOKIE设置为浏览器进程
2009/06/21 PHP
php 智能404跳转代码,适合换域名没改变目录的网站
2010/06/04 PHP
PHP实现自动识别Restful API的返回内容类型
2015/02/07 PHP
Laravel框架中VerifyCsrfToken报错问题的解决
2017/08/30 PHP
PHP给源代码加密的几种方法汇总(推荐)
2018/02/06 PHP
如何运行/调试你的PHP代码
2020/10/23 PHP
extjs 为某个事件设置拦截器
2010/01/15 Javascript
javascript代码编写需要注意的7个小细节小结
2011/09/21 Javascript
关于图片按比例自适应缩放的js代码
2011/10/30 Javascript
jQuery拖拽div实现思路
2014/02/19 Javascript
通过js来制作复选框的全选和不选效果
2014/05/22 Javascript
JS实现按比例缩放图片的方法(附C#版代码)
2015/12/08 Javascript
Jquery获取第一个子元素简单实例
2016/06/02 Javascript
关于页面刷新vuex数据消失问题解决方案
2017/07/03 Javascript
ES6 javascript中Class类继承用法实例详解
2017/10/30 Javascript
vuex 的简单使用
2018/03/22 Javascript
vue拖拽组件使用方法详解
2018/12/01 Javascript
Vue实现boradcast和dispatch的示例
2020/11/13 Javascript
Webpack3+React16代码分割的实现
2021/03/03 Javascript
利用Python绘制MySQL数据图实现数据可视化
2015/03/30 Python
浅析Python编写函数装饰器
2016/03/18 Python
pytorch实现CNN卷积神经网络
2020/02/19 Python
PyQt5结合matplotlib绘图的实现示例
2020/09/15 Python
html5 Canvas画图教程(7)—canvas里画曲线之quadraticCurveTo方法
2013/01/09 HTML / CSS
HTML5、Select下拉框右边加图标的实现代码(增进用户体验)
2017/10/16 HTML / CSS
美体小铺瑞典官方网站:The Body Shop瑞典
2018/01/27 全球购物
高职教师岗位职责
2013/12/24 职场文书
甜品店的创业计划书范文
2014/01/02 职场文书
商场消防管理制度
2014/01/12 职场文书
《最可爱的人》教学反思
2014/02/14 职场文书
乡镇领导干部个人对照检查材料思想汇报
2014/09/23 职场文书
拾金不昧表扬稿大全
2015/05/05 职场文书
社区敬老月活动总结
2015/05/07 职场文书
2015年留守儿童工作总结
2015/05/22 职场文书
MySQL 角色(role)功能介绍
2021/04/24 MySQL
python人工智能human learn绘图可创建机器学习模型
2021/11/23 Python