JavaScript编码规范有哪些
创始人
2024-12-25 18:03:25
0次

文件组织

  所有的javascript文件都要放在项目公共的'''script'''文件夹下

  使用的第三方库文件放置在'''script/lib'''文件夹下

  可以复用的自定义模块放置在'''script/commons'''夹下,复用模块如果涉及多个子文件,需要单独建立模块文件夹

  单独页面模块使用的javascript文件放置在'''script/{module_name}'''文件夹下

  项目模拟的json数据放置在'''script/json'''文件夹下,按照页面单独建立子文件夹

  javascript应用MVC框架时,使用的模板文件放置在'''script/templates'''文件夹下,按照页面单独建立子文件夹

格式化

  通用原则可以参考[PhpGuidelinePHP编码规范]

  始终使用var定义变量

  varglobal='';

  functionmethod(){

  varlocal='';

  }

  始终使用分号结束一行声明语句

  对于数组和对象不要使用多余的","(兼容IE)

  //wrong

  vararr=[1,2,];

  varperson={

  name:'name',

  age:20,

  };

  //wrong

  vararr=[1,2];

  varperson={

  name:'name',

  age:20

  };

  定义顶级命名空间如inBike,在顶级命名空间下自定义私有命名空间,根据模块分级

  所有的模块代码放在匿名自调用函数中,通过给window对象下的自定义命名空间赋值暴露出来

  if(!window.inBike){

  window.inBike={};

  }

  window.inBike.rideway=rideway;

  绑定事件代码需要放置在domready函数中执行

  $(function(){

  //bindfunctionisintheinitfunction

  window.inBike.rideway.init();

  })

  将自定义模块方法放置在对象中,方法名紧挨":",":"与function之间空一格,function()与后面的"{"之间空一格

  varmodule=function(){

  method:function(){

  }

  };

使用单引号包裹字符串

  varstr='sometext';

  所用的变量使用之前需要定义,定义之后立即初始化

  varobj=null;

  varnum=0;

  vararr=[];

  varisEmpty=true;

  使用浏览器console工具之前先要判断是否支持

  if(console){

  console.log('thisismylog');

  }

命名

  通用原则可以参考[PhpGuidelinePHP编码规范]

  使用驼峰法命名变量和方法名,首字母使用小写,对于类名首字母大写

  varnumberList=[1,2];

  varutil={

  removeNode:function(){

  ....

  }

  };

  functionPerson(name,age){

  this.name=name;

  this.age=age;

  }

  使用$name命名jquery对象,原生dom元素使用dom开头,对象中私有变量以下划线开头

  var$image=$('#cover');

  vardomImage=document.getElementById('cover');

  varobj={

  _privateVar:null,

  method:function(){

  }

  };

注释

  通用原则可以参考[PhpGuidelinePHP编码规范]

  多使用单行注释表明逻辑块的意义

  //HandlethecasewhereIEandOperareturnitems

  //bynameinsteadofID

  if(elem.id!==match[2]){

  returnrootjQuery.find(selector);

  }

  //Otherwise,weinjecttheelementdirectlyintothejQueryobject

  this.length=1;

  this[0]=elem;

相关内容

热门资讯

空调连续工作多久需要停机休息 空调连续工作的时间取决于多个因素,包括空调的型号、功率、使用环境和维护情况等。一般来说,空调可以连续...
空调哪个符号是除湿的 空调除湿功能通常用一个水滴形状的符号表示。不同品牌和型号的空调遥控器可能会有所差异,但一般来说,除湿...
格力空调多长时间加一次氟利昂 1、一般情况下,空调对氟利昂的使用量是非常小的,所以在空调使用了四年左右的时候再考虑加也没问题。2、...
空调用多长时间需要加氟一次 一般情况下是五年。当出现以下这几种情况时,空调才需要加氟。1、空调的室内机和室外机各有两个接口,当接...
格调生活·C标思享荟:卡萨帝在... 9月12日的郑州龙湖金融岛,夜风轻拂,灯光璀璨。“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑...
品牌价值破千亿、高端份额持续领... 9月12日,“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑州站”在郑州龙湖金融岛举办。2026...
空调主板坏了修800还是换新的 空调主板坏了是修还是换新,需要考虑多个因素,以下是一些建议:1. 维修成本:如果维修费用较低,比如 ...
空调开多久需要休息多长时间 问题:空调开多久需要休息多长时间回答:1、在使用空调的过程中,一般空调开7~8个小时左右需要休息2~...
中央空调多长时间清洗一次 1、一般空调开机前清洗一次即可,空调开机中间时段再清洗一次,空调关机时清洗一次,这样比较合理。2、空...
中央空调氟利昂多久加一次 看空调制热和制冷程度,很多人的观点认为氟利昂必须一年放一次,其实这个观点是错误的,理解上面有点偏差,...