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編碼規范有哪些就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。