前端代碼規(guī)范

第一部分

編寫(xiě)靈活语婴、穩(wěn)定牍白、高質(zhì)量的HTML代碼的規(guī)范

一首有、唯一定律

無(wú)論有多少人共同參與同一項(xiàng)目戒洼,一定要確保每一行代碼都像是唯一個(gè)人編寫(xiě)的俏橘。

二、HTML

2.1 語(yǔ)法

(1)用兩個(gè)空格來(lái)代替制表符(tab) -- 這是唯一能保證在所有環(huán)境下獲得一致展現(xiàn)的方法圈浇。

(2)嵌套元素應(yīng)當(dāng)縮進(jìn)一次(即兩個(gè)空格)寥掐。

(3)對(duì)于屬性的定義,確保全部使用雙引號(hào)磷蜀,絕不要使用單引號(hào)召耘。

(4)不要在自閉合(self-closing)元素的尾部添加斜線 -- HTML5 規(guī)范中明確說(shuō)明這是可選的。

(5)不要省略可選的結(jié)束標(biāo)簽(closing tag)(例如褐隆,</li> 或 </body>)怎茫。

2.2 Example

三、HTML5 doctype

為每個(gè) HTML 頁(yè)面的第一行添加標(biāo)準(zhǔn)模式(standard mode)的聲明妓灌,這樣能夠確保在每個(gè)瀏覽器中擁有一致的展現(xiàn)轨蛤。

四、語(yǔ)言屬性

根據(jù) HTML5 規(guī)范:

強(qiáng)烈建議為 html 根元素指定 lang 屬性虫埂,從而為文檔設(shè)置正確的語(yǔ)言祥山。這將有助于語(yǔ)音合成工具確定其所應(yīng)該采用的發(fā)音,有助于翻譯工具確定其翻譯時(shí)所應(yīng)遵守的規(guī)則等等掉伏。

五缝呕、IE 兼容模式

IE 支持通過(guò)特定的 <meta> 標(biāo)簽來(lái)確定繪制當(dāng)前頁(yè)面所應(yīng)該采用的 IE 版本。除非有強(qiáng)烈的特殊需求斧散,否則最好是設(shè)置為 edge mode供常,從而通知 IE 采用其所支持的最新的模式。

六鸡捐、字符編碼

通過(guò)明確聲明字符編碼栈暇,能夠確保瀏覽器快速并容易的判斷頁(yè)面內(nèi)容的渲染方式。這樣做的好處是箍镜,可以避免在 HTML 中使用字符實(shí)體標(biāo)記(character entity)源祈,從而全部與文檔編碼一致(一般采用 UTF-8 編碼)。

七色迂、引入 CSS 和 JavaScript 文件

根據(jù) HTML5 規(guī)范香缺,在引入 CSS 和 JavaScript 文件時(shí)一般不需要指定 type 屬性,因?yàn)?text/css 和 text/javascript 分別是它們的默認(rèn)值歇僧。

八图张、實(shí)用為王

盡量遵循 HTML 標(biāo)準(zhǔn)和語(yǔ)義,但是不要以犧牲實(shí)用性為代價(jià)。任何時(shí)候都要盡量使用最少的標(biāo)簽并保持最小的復(fù)雜度祸轮。

九姑隅、屬性順序

9.1 從大到小

HTML 屬性應(yīng)當(dāng)按照以下給出的順序依次排列,確保代碼的易讀性倔撞。

(1)class

(2)id, name

(3)data-*

(4)src, for, type, href, value

(5)title, alt

(6)role, aria-*

9.2 Example

9.3 說(shuō)明

class 用于標(biāo)識(shí)高度可復(fù)用組件,因此應(yīng)該排在首位慕趴。id 用于標(biāo)識(shí)具體組件痪蝇,應(yīng)當(dāng)謹(jǐn)慎使用(例如,頁(yè)面內(nèi)的書(shū)簽)冕房,因此排在第二位躏啰。

十、布爾(boolean)型屬性

10.1 注意

(1)布爾型屬性可以在聲明時(shí)不賦值耙册。XHTML 規(guī)范要求為其賦值给僵,但是 HTML5 規(guī)范不需要。

(2)元素的布爾型屬性如果有值详拙,就是 true帝际,如果沒(méi)有值,就是 false饶辙。

(3)如果屬性存在蹲诀,其值必須是空字符串或 [...] 屬性的規(guī)范名稱,并且不要在首尾添加空白符弃揽。
簡(jiǎn)單來(lái)說(shuō)脯爪,就是不用賦值。

10.2 Example

十一矿微、減少標(biāo)簽的數(shù)量

編寫(xiě) HTML 代碼時(shí)痕慢,盡量避免多余的父元素。很多時(shí)候涌矢,這需要迭代和重構(gòu)來(lái)實(shí)現(xiàn)掖举。

十二、減少 JavaScript 生成的標(biāo)簽

通過(guò) JavaScript 生成的標(biāo)簽讓內(nèi)容變得不易查找娜庇、編輯拇泛,并且降低性能。能避免時(shí)盡量避免思灌。


第二部分

編寫(xiě)靈活俺叭、穩(wěn)定、高質(zhì)量的CSS代碼的規(guī)范

一泰偿、語(yǔ)法

1.1 注意

(1)用兩個(gè)空格來(lái)代替制表符(tab) -- 這是唯一能保證在所有環(huán)境下獲得一致展現(xiàn)的方法熄守。

(2)為選擇器分組時(shí),將單獨(dú)的選擇器單獨(dú)放在一行。

(3)為了代碼的易讀性裕照,在每個(gè)聲明塊的左花括號(hào)前添加一個(gè)空格攒发。

(4)聲明塊的右花括號(hào)應(yīng)當(dāng)單獨(dú)成行。

(5)每條聲明語(yǔ)句之后應(yīng)該插入一個(gè)空格晋南。

(6)為了獲得更準(zhǔn)確的錯(cuò)誤報(bào)告惠猿,每條聲明都應(yīng)該獨(dú)占一行。

(7)所有聲明語(yǔ)句都應(yīng)當(dāng)以分號(hào)結(jié)尾负间。最后一條聲明語(yǔ)句后面的分號(hào)是可選的偶妖,但是,如果省略這個(gè)分號(hào)政溃,你的代碼可能更易出錯(cuò)趾访。

(8)對(duì)于以逗號(hào)分隔的屬性值,每個(gè)逗號(hào)后面都應(yīng)該插入一個(gè)空格(例如 董虱,box-shadow)扼鞋。

(9)不要在 rgb()、rgba()愤诱、hsl()云头、hsla() 或 rect() 值的內(nèi)部的逗號(hào)后面插入空格。這樣利于從多個(gè)屬性值(既加逗號(hào)也加空格)中區(qū)分多個(gè)顏色值(只加逗號(hào)淫半,不加空格)盘寡。

(10)對(duì)于屬性值或顏色參數(shù),省略小于 1 的小數(shù)前面的 0 (例如撮慨,.5 代替 0.5竿痰;-.5px 代替 -0.5px)。

(11)十六進(jìn)制值應(yīng)該全部小寫(xiě)砌溺,例如影涉,#fff。在掃描文檔時(shí)规伐,小寫(xiě)字符易于分辨蟹倾,因?yàn)樗麄兊男问礁子趨^(qū)分。

(12)盡量使用簡(jiǎn)寫(xiě)形式的十六進(jìn)制值猖闪,例如鲜棠,用 #fff 代替 #ffffff。

(13)為選擇器中的屬性添加雙引號(hào)培慌,例如豁陆,input[type="text"]。只有在某些情況下是可選的吵护,但是盒音,為了代碼的一致性表鳍,建議都加上雙引號(hào)。

(14)避免為 0 值指定單位祥诽,例如譬圣,用 margin: 0; 代替 margin: 0px;。

1.2 Example

二雄坪、聲明順序

2.1 相關(guān)屬性一組

相關(guān)的屬性聲明應(yīng)當(dāng)歸為一組厘熟,并按照下面的順序排列:

(1)Positioning

(2)Box model

(3)Typographic

(4)Visual

2.2 說(shuō)明

(1)由于定位(positioning)可以從正常的文檔流中移除元素,并且還能覆蓋盒模型(box model)相關(guān)的樣式维哈,因此排在首位绳姨。

(2)盒模型排在第二位,因?yàn)樗鼪Q定了組件的尺寸和位置笨农。

(3)其他屬性只是影響組件的內(nèi)部(inside)或者是不影響前兩組屬性,因此排在后面帖渠。

2.3 Example

三谒亦、不要使用 @import

3.1 不用原因

與 <link> 標(biāo)簽相比,@import 指令要慢很多空郊,不光增加了額外的請(qǐng)求次數(shù)份招,還會(huì)導(dǎo)致不可預(yù)料的問(wèn)題。

3.2替代方法

(1)使用多個(gè) <link> 元素

(2)通過(guò) Sass 或 Less 類似的 CSS 預(yù)處理器將多個(gè) CSS 文件編譯為一個(gè)文件

(3)通過(guò) Rails狞甚、Jekyll 或其他系統(tǒng)中提供過(guò) CSS 文件合并功能

3.3 Example

四锁摔、媒體查詢(Media query)的位置

4.1 相關(guān)規(guī)則附近

將媒體查詢放在盡可能相關(guān)規(guī)則的附近。不要將他們打包放在一個(gè)單一樣式文件中或者放在文檔底部哼审。如果你把他們分開(kāi)了谐腰,將來(lái)只會(huì)被大家遺忘。

4.2 Example

五涩盾、帶前綴的屬性

5.1 垂直對(duì)齊

當(dāng)使用特定廠商的帶有前綴的屬性時(shí)十气,通過(guò)縮進(jìn)的方式,讓每個(gè)屬性的值在垂直方向?qū)R春霍,這樣便于多行編輯砸西。

5.2 Example

六、單行規(guī)則聲明

6.1 放在一行

對(duì)于只包含一條聲明的樣式址儒,為了易讀性和便于快速編輯芹枷,建議將語(yǔ)句放在同一行。對(duì)于帶有多條聲明的樣式莲趣,還是應(yīng)當(dāng)將聲明分為多行鸳慈。

6.2 錯(cuò)誤檢測(cè)

這樣做的關(guān)鍵因素是為了錯(cuò)誤檢測(cè) -- 例如,CSS 校驗(yàn)器指出在 100 行有語(yǔ)法錯(cuò)誤喧伞。如果是單行單條聲明蝶涩,你就不會(huì)忽略這個(gè)錯(cuò)誤理朋;如果是單行多條聲明的話,你就要仔細(xì)分析避免漏掉錯(cuò)誤了绿聘。

6.3 Example

七嗽上、簡(jiǎn)寫(xiě)形式的屬性聲明

7.1 濫用簡(jiǎn)寫(xiě)

在需要顯示地設(shè)置所有值的情況下,應(yīng)當(dāng)盡量限制使用簡(jiǎn)寫(xiě)形式的屬性聲明熄攘。常見(jiàn)的濫用簡(jiǎn)寫(xiě)屬性聲明的情況如下:

(1)padding

(2)margin

(3)font

(4)background

(5)border

(5)border-radius

7.2 說(shuō)明

大部分情況下兽愤,我們不需要為簡(jiǎn)寫(xiě)形式的屬性聲明指定所有值。例如挪圾,HTML 的 heading 元素只需要設(shè)置上浅萧、下邊距(margin)的值,因此哲思,在必要的時(shí)候洼畅,只需覆蓋這兩個(gè)值就可以。過(guò)度使用簡(jiǎn)寫(xiě)形式的屬性聲明會(huì)導(dǎo)致代碼混亂棚赔,并且會(huì)對(duì)屬性值帶來(lái)不必要的覆蓋從而引起意外的副作用帝簇。

7.3 Example

八、Less 和 Sass 中的嵌套

8.1 盡量不嵌套

避免不必要的嵌套靠益。這是因?yàn)殡m然你可以使用嵌套丧肴,但是并不意味著應(yīng)該使用嵌套。只有在必須將樣式限制在父元素內(nèi)(也就是后代選擇器)胧后,并且存在多個(gè)需要嵌套的元素時(shí)才使用嵌套芋浮。

8.2 Example

九、Less 和 Sass 中的操作符

為了提高可讀性壳快,在圓括號(hào)中的數(shù)學(xué)計(jì)算表達(dá)式的數(shù)值纸巷、變量和操作符之間均添加一個(gè)空格。

十眶痰、注釋

10.1 注意

代碼是由人編寫(xiě)并維護(hù)的何暇。請(qǐng)確保你的代碼能夠自描述、注釋良好并且易于他人理解凛驮。好的代碼注釋能夠傳達(dá)上下文關(guān)系和代碼目的裆站。不要簡(jiǎn)單地重申組件或 class 名稱。

對(duì)于較長(zhǎng)的注釋黔夭,務(wù)必書(shū)寫(xiě)完整的句子宏胯;對(duì)于一般性注解,可以書(shū)寫(xiě)簡(jiǎn)潔的短語(yǔ)本姥。

10.2 Example

十一肩袍、class 命名

11.1 規(guī)范

(1)class 名稱中只能出現(xiàn)小寫(xiě)字符和破折號(hào)(dashe)(不是下劃線,也不是駝峰命名法)婚惫。破折號(hào)應(yīng)當(dāng)用于相關(guān) class 的命名(類似于命名空間)(例如氛赐,.btn 和 .btn-danger)魂爪。

(2)避免過(guò)度任意的簡(jiǎn)寫(xiě)。.btn 代表 button艰管,但是 .s 不能表達(dá)任何意思滓侍。

(3)class 名稱應(yīng)當(dāng)盡可能短,并且意義明確牲芋。

(4)使用有意義的名稱撩笆。使用有組織的或目的明確的名稱,不要使用表現(xiàn)形式(presentational)的名稱缸浦。

(5)基于最近的父 class 或基本(base) class 作為新 class 的前綴夕冲。

(6)使用 .js-* class 來(lái)標(biāo)識(shí)行為(與樣式相對(duì)),并且不要將這些 class 包含到 CSS 文件中裂逐。

在為 Sass 和 Less 變量命名時(shí)也可以參考上面列出的各項(xiàng)規(guī)范歹鱼。

11.2 Example

十二、選擇器

12.1 注意

(1)對(duì)于通用元素使用 class 卜高,這樣利于渲染性能的優(yōu)化弥姻。

(2)對(duì)于經(jīng)常出現(xiàn)的組件,避免使用屬性選擇器(例如篙悯,[class^="..."])蚁阳。瀏覽器的性能會(huì)受到這些因素的影響铃绒。

(3)選擇器要盡可能短鸽照,并且盡量限制組成選擇器的元素個(gè)數(shù),建議不要超過(guò) 3 颠悬。

(4)只有在必要的時(shí)候才將 class 限制在最近的父元素內(nèi)(也就是后代選擇器)(例如矮燎,不使用帶前綴的 class 時(shí) -- 前綴類似于命名空間)。

12.2 Example

十三赔癌、代碼組織

13.1 注意

(1)以組件為單位組織代碼段诞外。

(2)制定一致的注釋規(guī)范。

(3)使用一致的空白符將代碼分隔成塊灾票,這樣利于掃描較大的文檔峡谊。

(4)如果使用了多個(gè) CSS 文件,將其按照組件而非頁(yè)面的形式分拆刊苍,因?yàn)轫?yè)面會(huì)被重組既们,而組件只會(huì)被移動(dòng)。

13.2 Example

十四正什、編輯器配置

14.1 避免代碼不同

將你的編輯器按照下面的配置進(jìn)行設(shè)置啥纸,以避免常見(jiàn)的代碼不一致和差異:

(1)用兩個(gè)空格代替制表符(soft-tab 即用空格代表 tab 符)。

(2)保存文件時(shí)婴氮,刪除尾部的空白符斯棒。

(3)設(shè)置文件編碼為 UTF-8盾致。

(4)在文件結(jié)尾添加一個(gè)空白行。


更多精彩文章

前端面試題

徹底明白JS線程

徹底明白js中的this

徹底明白閉包

超實(shí)用代碼片段

前端-掃碼登錄實(shí)現(xiàn)原理

關(guān)注公眾號(hào)【grain先森】荣暮,回復(fù)關(guān)鍵詞 【18福利】庭惜,獲取為你準(zhǔn)備的年終福利,更多關(guān)鍵詞玩法期待你的探索~

文章中錯(cuò)別字或其他錯(cuò)誤渠驼,歡迎小伙伴們下方評(píng)論指正蜈块,小編會(huì)盡快更正。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末迷扇,一起剝皮案震驚了整個(gè)濱河市百揭,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌蜓席,老刑警劉巖器一,帶你破解...
    沈念sama閱讀 218,640評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異厨内,居然都是意外死亡祈秕,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,254評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門雏胃,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)请毛,“玉大人,你說(shuō)我怎么就攤上這事瞭亮》椒拢” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,011評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵统翩,是天一觀的道長(zhǎng)仙蚜。 經(jīng)常有香客問(wèn)我,道長(zhǎng)厂汗,這世上最難降的妖魔是什么委粉? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,755評(píng)論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮娶桦,結(jié)果婚禮上贾节,老公的妹妹穿的比我還像新娘。我一直安慰自己衷畦,他們只是感情好栗涂,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,774評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著霎匈,像睡著了一般戴差。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上铛嘱,一...
    開(kāi)封第一講書(shū)人閱讀 51,610評(píng)論 1 305
  • 那天暖释,我揣著相機(jī)與錄音袭厂,去河邊找鬼。 笑死球匕,一個(gè)胖子當(dāng)著我的面吹牛纹磺,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播亮曹,決...
    沈念sama閱讀 40,352評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼橄杨,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了照卦?” 一聲冷哼從身側(cè)響起式矫,我...
    開(kāi)封第一講書(shū)人閱讀 39,257評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎役耕,沒(méi)想到半個(gè)月后采转,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,717評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡瞬痘,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,894評(píng)論 3 336
  • 正文 我和宋清朗相戀三年故慈,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片框全。...
    茶點(diǎn)故事閱讀 40,021評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡察绷,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出津辩,到底是詐尸還是另有隱情拆撼,我是刑警寧澤,帶...
    沈念sama閱讀 35,735評(píng)論 5 346
  • 正文 年R本政府宣布丹泉,位于F島的核電站情萤,受9級(jí)特大地震影響鸭蛙,放射性物質(zhì)發(fā)生泄漏摹恨。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,354評(píng)論 3 330
  • 文/蒙蒙 一娶视、第九天 我趴在偏房一處隱蔽的房頂上張望晒哄。 院中可真熱鬧,春花似錦肪获、人聲如沸寝凌。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,936評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)较木。三九已至,卻和暖如春青柄,著一層夾襖步出監(jiān)牢的瞬間伐债,已是汗流浹背预侯。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,054評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留峰锁,地道東北人萎馅。 一個(gè)月前我還...
    沈念sama閱讀 48,224評(píng)論 3 371
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像虹蒋,于是被迫代替她去往敵國(guó)和親糜芳。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,974評(píng)論 2 355