JavaScript编码规范有哪些

这篇文章给大家介绍JavaScript编码规范有哪些，内容非常详细，感兴趣的小伙伴们可以参考借鉴，希望对大家能有所帮助。

文件组织

　　所有的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;

关于JavaScript编码规范有哪些就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。