This is a good example for HTML semantics
這篇文章主要介紹“前端開發(fā)的規(guī)范有哪些”,在日常操作中,相信很多人在前端開發(fā)的規(guī)范有哪些問題上存在疑惑,小編查閱了各式資料,整理出簡(jiǎn)單好用的操作方法,希望對(duì)大家解答”前端開發(fā)的規(guī)范有哪些”的疑惑有所幫助!接下來,請(qǐng)跟著小編一起來學(xué)習(xí)吧!
網(wǎng)站建設(shè)哪家好,找成都創(chuàng)新互聯(lián)公司!專注于網(wǎng)頁設(shè)計(jì)、網(wǎng)站建設(shè)、微信開發(fā)、小程序定制開發(fā)、集團(tuán)企業(yè)網(wǎng)站建設(shè)等服務(wù)項(xiàng)目。為回饋新老客戶創(chuàng)新互聯(lián)還提供了平定免費(fèi)建站歡迎大家使用!
Pascal Case 大駝峰式命名法:首字母大寫。eg:StudentInfo、UserInfo、ProductInfo
Camel Case 小駝峰式命名法:首字母小寫。eg:studentInfo、userInfo、productInfo文件資源命名
文件名不得含有空格
文件名建議只使用小寫字母,不使用大寫字母。( 為了醒目,某些說明文件的文件名,可以使用大寫字母,比如README、LICENSE。 )
文件名包含多個(gè)單詞時(shí),單詞之間建議使用半角的連詞線 ( - ) 分隔。
引入資源使用相對(duì)路徑,不要指定資源所帶的具體協(xié)議 ( http:,https: ) ,除非這兩者協(xié)議都不可用。
不推薦:
推薦
命名方式: 小駝峰式命名方法命名規(guī)范: 類型+對(duì)象描述的方式,如果沒有明確的類型,就可以使前綴為名詞
推薦
var tableTitle = "LoginTable"
不推薦
var getTitle = "LoginTable"
命名方式: 小駝峰方式 ( 構(gòu)造函數(shù)使用大駝峰命名法 )命名規(guī)則: 前綴為動(dòng)詞
推薦:
//是否可閱讀 function canRead(){ return true; } //獲取姓名 function getName{ return this.name }
命名方法: 全部大寫命名規(guī)范: 使用大寫字母和下劃線來組合命名,下劃線用以分割單詞。推薦:
var MAX_COUNT = 10; var URL = 'http://www.baidu.com';
公共屬性和方法 : 同變量命名方式
私有屬性和方法 : 前綴為下劃線(_)后面跟公共屬性和方法一樣的命名方式
推薦(將name換成this是不是更熟悉了呢)
function Student(name) { var _name = name; // 私有成員 // 公共方法 this.getName = function () { return _name; } // 公共方式 this.setName = function (value) { _name = value; } } var st = new Student('tom'); st.setName('jerry'); console.log(st.getName()); // => jerry:輸出_name私有變量的值
單獨(dú)一行://(雙斜線)與注釋文字之間保留一個(gè)空格
在代碼后面添加注釋://(雙斜線)與代碼之間保留一個(gè)空格,并且//(雙斜線)與注釋文字之間保留一個(gè)空格。
注釋代碼://(雙斜線)與代碼之間保留一個(gè)空格。
推薦 :
// 調(diào)用了一個(gè)函數(shù);1)單獨(dú)在一行 setTitle(); var maxCount = 10; // 設(shè)置最大量;2)在代碼后面注釋 // setName(); // 3)注釋代碼
若開始(/*和結(jié)束(*/)都在一行,推薦采用單行注釋
若至少三行注釋時(shí),第一行為/*,最后行為*/,其他行以*開始,并且注釋文字與*保留一個(gè)空格。
推薦 : /* * 代碼執(zhí)行到這里后會(huì)調(diào)用setTitle()函數(shù) * setTitle():設(shè)置title的值 */ setTitle();復(fù)制代碼
函數(shù)(方法)注釋也是多行注釋的一種,但是包含了特殊的注釋要求,參照 javadoc(百度百科)語法:
/** * 函數(shù)說明 * @關(guān)鍵字 */復(fù)制代碼
常用注釋關(guān)鍵字
推薦 :
/** - 合并Grid的行 - @param grid {Ext.Grid.Panel} 需要合并的Grid - @param cols {Array} 需要合并列的Index(序號(hào))數(shù)組;從0開始計(jì)數(shù),序號(hào)也包含。 - @param isAllSome {Boolean} :是否2個(gè)tr的cols必須完成一樣才能進(jìn)行合并。true:完成一樣;false(默認(rèn)):不完全一樣 - @return void - @author polk6 2015/07/21 - @example - _________________ _________________ - | 年齡 | 姓名 | | 年齡 | 姓名 | - ----------------- mergeCells(grid,[0]) ----------------- - | 18 | 張三 | => | | 張三 | - ----------------- - 18 --------- - | 18 | 王五 | | | 王五 | - ----------------- ----------------- */ function mergeCells(grid, cols, isAllSome) { // Do Something }
使用 HTML5 的文檔聲明類型 :
DOCTYPE標(biāo)簽是一種標(biāo)準(zhǔn)通用標(biāo)記語言的文檔類型聲明,它的目的是要告訴標(biāo)準(zhǔn)通用標(biāo)記語言解析器,它應(yīng)該使用什么樣的文檔類型定義(DTD)來解析文檔。
使用文檔聲明類型的作用是為了防止開啟瀏覽器的怪異模式。
沒有DOCTYPE文檔類型聲明會(huì)開啟瀏覽器的怪異模式,瀏覽器會(huì)按照自己的解析方式渲染頁面,在不同的瀏覽器下面會(huì)有不同的樣式。
如果你的頁面添加了那么,那么就等同于開啟了標(biāo)準(zhǔn)模式。瀏覽器會(huì)按照W3C標(biāo)準(zhǔn)解析渲染頁面。
說到j(luò)s和css的位置,大家應(yīng)該都知道js放在下面,css放在上面。但是,如果你的項(xiàng)目只需要兼容ie10+或者只是在移動(dòng)端訪問,那么可以使用HTML5的新屬性async,將腳本文件放在
內(nèi)兼容老舊瀏覽器(IE9-)時(shí):腳本引用寫在 body 結(jié)束標(biāo)簽之前,并帶上 async 屬性。這雖然在老舊瀏覽器中不會(huì)異步加載腳本,但它只阻塞了 body 結(jié)束標(biāo)簽之前的 DOM 解析,這就大大降低了其阻塞影響。而在現(xiàn)代瀏覽器中:腳本將在 DOM 解析器發(fā)現(xiàn) body 尾部的 script 標(biāo)簽才進(jìn)行加載,此時(shí)加載屬于異步加載,不會(huì)阻塞 CSSOM(但其執(zhí)行仍發(fā)生在 CSSOM 之后)。綜上所述,所有瀏覽器中推薦:只兼容現(xiàn)代瀏覽器推薦:
我們一直都在說語義化編程,語義化編程,但是在代碼中很少有人完全使用正確的元素。使用語義化標(biāo)簽也是有理由SEO的。
語義化是指:根據(jù)元素其被創(chuàng)造出來時(shí)的初始意義來使用它。意思就是用正確的標(biāo)簽干正確的事,而不是只有div和span。
不推薦:
My page titleAll news articlesBad article
Introduction sub-titleThis is a very bad example for HTML semanticsI think I'm more on the side and should not receive the main creditsThis article was created by David2014-01-01 00:00Related sections: Events, Public holidaysCopyright 2014
推薦
html 代碼:My page title
All news articles
Good articleIntroduction sub-titleThis is a good example for HTML semantics
標(biāo)簽的 alt 屬性指定了替代文本,用于在圖像無法顯示或者用戶禁用圖像顯示時(shí),代替圖像顯示在瀏覽器中的內(nèi)容。假設(shè)由于下列原因用戶無法查看圖像,alt 屬性可以為圖像提供替代的信息:
網(wǎng)速太慢
src 屬性中的錯(cuò)誤
瀏覽器禁用圖像
用戶使用的是屏幕閱讀器
從SEO角度考慮,瀏覽器的爬蟲爬不到圖片的內(nèi)容,所以我們要有文字告訴爬蟲圖片的內(nèi)容
盡量在文檔和模板中只包含結(jié)構(gòu)性的 HTML;而將所有表現(xiàn)代碼,移入樣式表中;將所有動(dòng)作行為,移入腳本之中。在此之外,為使得它們之間的聯(lián)系盡可能的小,在文檔和模板中也盡量少地引入樣式和腳本文件。建議:
不使用超過一到兩張樣式表
不使用超過一到兩個(gè)腳本(學(xué)會(huì)用合并腳本)
不使用行內(nèi)樣式()
不在元素上使用 style 屬性(
不使用行內(nèi)腳本()
不使用表象元素(i.e. , ,
不使用表象 class 名(i.e. red, left, center)
HTML只顯示展示內(nèi)容信息
不要引入一些特定的 HTML 結(jié)構(gòu)來解決一些視覺設(shè)計(jì)問題
不要將img元素當(dāng)做專門用來做視覺設(shè)計(jì)的元素
樣式上的問題應(yīng)該使用css解決
不推薦:
See the square next to me? css 代碼: .text-box > .square { display: inline-block; width: 1rem; height: 1rem; background-color: red; }
推薦
html 代碼: See the square next to me? css 代碼: /* We use a :before pseudo element to solve the design problem of placing a colored square in front of the text content */ .text-box:before { content: ""; display: inline-block; width: 1rem; height: 1rem; background-color: red; }
圖片和 SVG 圖形能被引入到 HTML 中的唯一理由是它們呈現(xiàn)出了與內(nèi)容相關(guān)的一些信息。
不推薦
html 代碼: See the square next to me?
推薦
html 代碼: See the square next to me? css 代碼: /* We use a :before pseudo element with a background image to solve the problem */ .text-box:before { content: ""; display: inline-block; width: 1rem; height: 1rem; background: url(square.svg) no-repeat; background-size: 100%; }
防止全局命名空間被污染,我們通常的做法是將代碼包裹成一個(gè) IIFE(Immediately-Invoked Function Expression),創(chuàng)建獨(dú)立隔絕的定義域。也使得內(nèi)存在執(zhí)行完后立即釋放。
IIFE 還可確保你的代碼不會(huì)輕易被其它全局命名空間里的代碼所修改(i.e. 第三方庫,window 引用,被覆蓋的未定義的關(guān)鍵字等等)。不推薦:
var x = 10, y = 100; // Declaring variables in the global scope is resulting in global scope pollution. All variables declared like this // will be stored in the window object. This is very unclean and needs to be avoided. console.log(window.x + ' ' + window.y);
推薦
// We declare a IIFE and pass parameters into the function that we will use from the global space (function(log, w, undefined){ 'use strict'; var x = 10, y = 100; // Will output 'true true' log((w.x === undefined) + ' ' + (w.y === undefined)); }(window.console.log, window));
推薦的IIFE寫法:
(function(){ 'use strict'; // Code goes here }());
如果你想引用全局變量或者是外層 IIFE 的變量,可以通過下列方式傳參:
(function($, w, d){ 'use strict'; $(function() { w.alert(d.querySelectorAll('div').length); }); }(jQuery, window, document));復(fù)制代碼
ECMAScript 5 嚴(yán)格模式可在整個(gè)腳本或獨(dú)個(gè)方法內(nèi)被激活。它對(duì)應(yīng)不同的 javascript 語境會(huì)做更加嚴(yán)格的錯(cuò)誤檢查。嚴(yán)格模式也確保了 javascript 代碼更加的健壯,運(yùn)行的也更加快速。
嚴(yán)格模式會(huì)阻止使用在未來很可能被引入的預(yù)留關(guān)鍵字。
你應(yīng)該在你的腳本中啟用嚴(yán)格模式,最好是在獨(dú)立的 IIFE 中應(yīng)用它。避免在你的腳本第一行使用它而導(dǎo)致你的所有腳本都啟動(dòng)了嚴(yán)格模式,這有可能會(huì)引發(fā)一些第三方類庫的問題。
總是使用 var 來聲明變量。如不指定 var,變量將被隱式地聲明為全局變量,例如
var a = b = 0; //b會(huì)被隱式的創(chuàng)建為全局變量復(fù)制代碼
所以,請(qǐng)總是使用 var 來聲明變量,并且使用單var模式(將所有的變量在函數(shù)最前面只使用一個(gè)var定義)。例如:
(function (){ 'use strict' var a = 0, b = 0, c = 0, i, j, myObject(); }())
采用嚴(yán)格模式帶來的好處是,當(dāng)你手誤輸入錯(cuò)誤的變量名時(shí),它可以通過報(bào)錯(cuò)信息來幫助你定位錯(cuò)誤出處。
javascript會(huì)自動(dòng)將函數(shù)作用域內(nèi)的變量和方法的定義提前(只是提前聲明,賦值還是在原處)例如:
(function(log){ 'use strict'; var a = 10; for(var i = 0; i < a; i++) { var b = i * i; log(b); } if(a === 10) { var f = function() { log(a); }; f(); } function x() { log('Mr. X!'); } x(); }(window.console.log));
提升后的js
(function(log){ 'use strict'; // All variables used in the closure will be hoisted to the top of the function var a, i, b, f; // All functions in the closure will be hoisted to the top function x() { log('Mr. X!'); } a = 10; for(i = 0; i < a; i++) { b = i * i; log(b); } if(a === 10) { // Function assignments will only result in hoisted variables but the function body will not be hoisted // Only by using a real function declaration the whole function will be hoisted with its body f = function() { log(a); }; f(); } x(); }(window.console.log));
總是使用 === 精確的比較操作符,避免在判斷的過程中,由 JavaScript 的強(qiáng)制類型轉(zhuǎn)換所造成的困擾。例如:
(function(log){ 'use strict'; log('0' == 0); // true log('' == false); // true log('1' == true); // true log(null == undefined); // true var x = { valueOf: function() { return 'X'; } }; log(x == 'X'); }(window.console.log));
==, 兩邊值類型不同的時(shí)候,要先進(jìn)行類型轉(zhuǎn)換,再比較。
===,不做類型轉(zhuǎn)換,類型不同的一定不等。
==等同操作符
如果兩個(gè)值具有相同類型,會(huì)進(jìn)行===比較,返回===的比較值
如果兩個(gè)值不具有相同類型,也有可能返回true
如果一個(gè)值是null另一個(gè)值是undefined,返回true
如果一個(gè)值是string另個(gè)是number,會(huì)把string轉(zhuǎn)換成number再進(jìn)行比較
如果一個(gè)值是true,會(huì)把它轉(zhuǎn)成1再比較,false會(huì)轉(zhuǎn)成0
console.log( false == null ) // false console.log( false == undefined ) // false console.log( false == 0 ) // true console.log( false == '' ) // true console.log( false == NaN ) // false console.log( null == undefined ) // true console.log( null == 0 ) // false console.log( null == '' ) // false console.log( null == NaN ) // false console.log( undefined == 0) // false console.log( undefined == '') // false console.log( undefined == NaN) // false console.log( 0 == '' ) // true console.log( 0 == NaN ) // false
總結(jié)一下==
false 除了和自身比較為 true 外,和 0,"" 比較也為 true
null 只和 undefined 比較時(shí)為 true, 反過來 undefined 也僅和 null 比較為 true,沒有第二個(gè)
0 除了和 false 比較為 true,還有空字符串 ''" 和空數(shù)組 []
空字符串 '' 除了和 false 比較為 true,還有一個(gè)數(shù)字 0
==, >, <, +, -, ... 這些操作符所造成的隱式類型轉(zhuǎn)換都是無副作用的,它不會(huì)改變變量本身保存的值。,但是,如果你覆寫某個(gè)對(duì)象的 valueOf/toString的話,==就會(huì)產(chǎn)生副作用.
例如:
Array.prototype.valueOf = function() { this[0]++; return this; } var x = [1, 2, 3]; x == 0; console.log(x); // [2, 2, 3]復(fù)制代碼
===操作符:
要是兩個(gè)值類型不同,返回false
要是兩個(gè)值都是number類型,并且數(shù)值相同,返回true
要是兩個(gè)值都是stirng,并且兩個(gè)值的String內(nèi)容相同,返回true
要是兩個(gè)值都是true或者都是false,返回true
要是兩個(gè)值都是指向相同的Object,Arraya或者function,返回true
要是兩個(gè)值都是null或者都是undefined,返回true
js中以下內(nèi)容為假:
false
null
undefined
0
'' (空字符串)
NaN
輯操作符 || 和 && 也可被用來返回布爾值。如果操作對(duì)象為非布爾對(duì)象,那每個(gè)表達(dá)式將會(huì)被自左向右地做真假判斷。基于此操作,最終總有一個(gè)表達(dá)式被返回回來。這在變量賦值時(shí),是可以用來簡(jiǎn)化你的代碼的。例如:如果x不存在且y不存在,x=1;如果x存在y存在,x = y
if(!x) { if(!y) { x = 1; } else { x = y; } }
等同于:
x = x || y || 1;復(fù)制代碼
這一小技巧經(jīng)常用來給方法設(shè)定默認(rèn)的參數(shù)。
(function(log){ 'use strict'; function multiply(a, b) { a = a || 1; b = b || 1; log('Result ' + a * b); } multiply(); // Result 1 multiply(10); // Result 10 multiply(3, NaN); // Result 3 multiply(9, 5); // Result 45 }(window.console.log));
就如eval的字面意思來說,惡魔,使用eval()函數(shù)會(huì)帶來安全隱患。eval()函數(shù)的作用是返回任意字符串,當(dāng)作js代碼來處理。
只在對(duì)象構(gòu)造器、方法和在設(shè)定的閉包中使用 this 關(guān)鍵字。this 的語義在此有些誤導(dǎo)。它時(shí)而指向全局對(duì)象(大多數(shù)時(shí)),時(shí)而指向調(diào)用者的定義域(在 eval 中),時(shí)而指向 DOM 樹中的某一節(jié)點(diǎn)(當(dāng)用事件處理綁定到 HTML 屬性上時(shí)),時(shí)而指向一個(gè)新創(chuàng)建的對(duì)象(在構(gòu)造器中),還時(shí)而指向其它的一些對(duì)象(如果函數(shù)被 call() 和 apply() 執(zhí)行和調(diào)用時(shí))。
正因?yàn)樗侨绱巳菀椎乇桓沐e(cuò),請(qǐng)限制它的使用場(chǎng)景:
在構(gòu)造函數(shù)中
在對(duì)象的方法中(包括由此創(chuàng)建出的閉包內(nèi))
函數(shù)式編程讓你可以簡(jiǎn)化代碼并縮減維護(hù)成本,因?yàn)樗菀讖?fù)用,又適當(dāng)?shù)亟怦詈透俚囊蕾嚒?/p>
接下來的例子中,在一組數(shù)字求和的同一問題上,比較了兩種解決方案。第一個(gè)例子是經(jīng)典的程序處理,而第二個(gè)例子則是采用了函數(shù)式編程和 ECMA Script 5.1 的數(shù)組方法。不推薦
(function(log){ 'use strict'; var arr = [10, 3, 7, 9, 100, 20], sum = 0, i; for(i = 0; i < arr.length; i++) { sum += arr[i]; } log('The sum of array ' + arr + ' is: ' + sum) }(window.console.log));
推薦(函數(shù)式編程):
(function(log){ 'use strict'; var arr = [10, 3, 7, 9, 100, 20]; var sum = arr.reduce(function(prevValue, currentValue) { return prevValue + currentValue; }, 0); log('The sum of array ' + arr + ' is: ' + sum); }(window.console.log));
修改內(nèi)建的諸如 Object.prototype 和 Array.prototype 是被嚴(yán)厲禁止的。修改其它的內(nèi)建對(duì)象比如 Function.prototype,雖危害沒那么大,但始終還是會(huì)導(dǎo)致在開發(fā)過程中難以 debug 的問題,應(yīng)當(dāng)也要避免。
用三元操作符分配或返回語句。在比較簡(jiǎn)單的情況下使用,避免在復(fù)雜的情況下使用。沒人愿意用 10 行三元操作符把自己的腦子繞暈。不推薦:
if(x === 10) { return 'valid'; } else { return 'invalid'; }
推薦:
return x === 10 ? 'valid' : 'invalid'
在js規(guī)范中,有很多規(guī)范都是樣式上的規(guī)范而不是邏輯上的規(guī)范,比如盡量使用===而不是==,我們可以使用JSHint或者JSLint,Javascript代碼驗(yàn)證工具,這種工具可以檢查你的代碼并提供相關(guān)的代碼改進(jìn)意見。我個(gè)人使用的是JSHint,所以就以這個(gè)為例
對(duì)于ws愛好者來說,我沒有用過其他的編譯器,ws基本上能滿足你的所有需求(最新的ws集成了vue)。在Settings => language & frameworks => JavaScript => Code Quality Tolls => JSHint
webstorm中的jshint
這些規(guī)范都是什么意思呢,這里列出一些常用的,剩下的大家可以參考官方文檔
ID和class的名稱總是使用可以反應(yīng)元素目的和用途的名稱,或其他通用的名稱,代替表象和晦澀難懂的名稱不推薦 :
.fw-800 { font-weight: 800; } .red { color: red; }
推薦 :
.heavy { font-weight: 800; } .important { color: red; }
一般情況下ID不應(yīng)該被用于樣式,并且ID的權(quán)重很高,所以不使用ID解決樣式的問題,而是使用class不推薦:
#content .title { font-size: 2em; }
推薦:
.content .title { font-size: 2em; }
從結(jié)構(gòu)、表現(xiàn)、行為分離的原則來看,應(yīng)該盡量避免css中出現(xiàn)HTML標(biāo)簽,并且在css選擇器中出現(xiàn)標(biāo)簽名會(huì)存在潛在的問題。
很多前端開發(fā)人員寫選擇器鏈的時(shí)候不使用 直接子選擇器(注:直接子選擇器和后代選擇器的區(qū)別)。有時(shí),這可能會(huì)導(dǎo)致疼痛的設(shè)計(jì)問題并且有時(shí)候可能會(huì)很耗性能。然而,在任何情況下,這是一個(gè)非常不好的做法。如果你不寫很通用的,需要匹配到DOM末端的選擇器, 你應(yīng)該總是考慮直接子選擇器。不推薦:
.content .title { font-size: 2rem; }
推薦
.content > .title { font-size: 2rem; }
盡量使用縮寫屬性對(duì)于代碼效率和可讀性是很有用的,比如font屬性。不推薦:
border-top-style: none; font-family: palatino, georgia, serif; font-size: 100%; line-height: 1.6; padding-bottom: 2em; padding-left: 1em; padding-right: 1em; padding-top: 0;
推薦:
border-top: 0; font: 100%/1.6 palatino, georgia, serif; padding: 0 1em 2em;
省略0后面的單位,不推薦:
padding-bottom: 0px; margin: 0em;
推薦:
padding-bottom: 0; margin: 0;
為了保證一致性和可擴(kuò)展性,每個(gè)聲明應(yīng)該用分號(hào)結(jié)束,每個(gè)聲明換行。
屬性名的冒號(hào)后使用一個(gè)空格。出于一致性的原因,
屬性和值(但屬性和冒號(hào)之間沒有空格)的之間始終使用一個(gè)空格。
每個(gè)選擇器和屬性聲明總是使用新的一行。
屬性選擇器或?qū)傩灾涤秒p引號(hào)(””),而不是單引號(hào)(”)括起來。
URI值(url())不要使用引號(hào)。
作為最佳實(shí)踐,我們應(yīng)該遵循以下順序(應(yīng)該按照下表的順序):
結(jié)構(gòu)性屬性:
display
position, left, top, right etc.
overflow, float, clear etc.
margin, padding
表現(xiàn)性屬性:
background, border etc.
font, text
不推薦:
.box { font-family: 'Arial', sans-serif; border: 3px solid #ddd; left: 30%; position: absolute; text-transform: uppercase; background-color: #eee; right: 30%; isplay: block; font-size: 1.5rem; overflow: hidden; padding: 1em; margin: 1em;
推薦:
.box { display: block; position: absolute; left: 30%; right: 30%; overflow: hidden; margin: 1em; padding: 1em; background-color: #eee; border: 3px solid #ddd; font-family: 'Arial', sans-serif; font-size: 1.5rem; text-transform: uppercase; }
到此,關(guān)于“前端開發(fā)的規(guī)范有哪些”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí),請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編會(huì)繼續(xù)努力為大家?guī)砀鄬?shí)用的文章!