热门关键字:
jquery > jquery教程 > jquery教程 > 编写jquery插件的开发规范

编写jquery插件的开发规范

4175
作者:管理员
发布时间:2012/8/4 16:04:06
评论数:0
转载请自觉注明原文:http://www.jq-school.com/Show.aspx?id=41
 
一、请给你的代码加上注释

很多人都不喜欢加注释,嫌太麻烦了,这是个非常糟糕的习惯。 世界不存在百分百的完美的jquery插件,注释不止是给别人看、更重要的是给自己看。 应该把注释当做你代码的一部分,养成随手加注释的习惯,尤其是编写javascript的时候。
 
1、在全部代码前加上文件说明注释
例如:
/*
* @extends jquery.1.7.2
* @fileOverview 搜索提示框
* @author zmc
* @email
* @sitewww.jq-school.com
* @version 0.2
* @date 2012-06-04
* Copyright (c) 2012 ZMC
*/
(function($){
    .......
})(jQuery);
 
2、函数务必加注释

比如以下代码是其中的一个方法setContents:
zmc.tips.prototype = {
/** *向提示框添加内容 */
setContents : function(content){
    ...........
}}
3、参数务必加注释

例如:
//默认参数
$.fn.tips.defaults = {
/**目标容器*/
applyTo : null,
/**内容*/
content : "",
/**搜索框的位置*/
position : "topMiddle",
/**搜索框位置偏移*/
offest : {"left":0,"top":0},
/**提示框颜色*
/ color : "blue"
}
 
 
二、javascript变量规范

在javascript中,没有真正意义的共有变量、私有变量、常量等概念,当javascript代码达到一定数量级时,过段时间回头看自己写的代码,会把自己也搞晕的。
1、请在私有变量前加“_” 比如: var _pub = this.pub;
2、常量请大写 比如: this.COLOR = "red";
3、jquery对象变量前加“$” 比如: this.$Obj = $("#layout");
4、object、array变量前加“o”、“a” 很多人喜欢给数组变量加个”s”,这也是可以的,按个人习惯,如果你觉得有必要还可以给函数前加个“fn”。
 
三、jquery插件开发的一些建议

1、请多使用data()方法 jquery中data()方法非常有用,尤其在jquery插件开发中,因为data()所创建的缓存,可以完整的保存各种数据类型的数据,这是其他缓存机制无法比拟的。
2、请使用bind来绑定事件 很多朋友喜欢以下的代码:

$(".yitip").click(function(){ ........ })

但在jquery插件开发中更提倡使用bind:
$(".yitip").bind('click',function(){ ......... })

3、善用typeof typeof用于判断数据类型,这个方法在参数判断中非常有用处
4、插件名加个独有前缀 jquery插件有太多太多了,插件撞车时很容易的事,比如搜索框插件:
$.fn.tips = function(options){ }





如果您觉得本文的内容对您的学习有所帮助:支付鼓励



关键字:编写jquery插件的开发规范
友荐云推荐