目錄

• 1.命名規(guī)范
• 1.1  項目命名
• 1.2  目錄命名
• 1.3 JS 、CSS 、SCSS 、HTML 、PNG  文件命名
• 1.4  命名嚴謹性
• 2.HTML規(guī)范
• 2.1 HTML  類型
• 2.2  縮進
• 2.3  分塊注釋
• 2.4  語義化標簽
• 2.5  引號
• 3 CSS  規(guī)范
• 3.1  命名
• 3.2  選擇器
• 3.3  盡量使用縮寫屬性
• 3.4  每個選擇器及屬性獨占一行
• 3.5  省略 0  后面的單位
• 4 Javascript  規(guī)范
• 4.1  命名
• 4.2  代碼格式
• 4.3  字符串
• 4.4  對象聲明
• 4.5 用 使用 ES6+
• 4.6  括號
• 4.7 undefined  判斷
• 4.8  條件判斷和循環(huán)最多三層
• 4.9 this  的轉換命名
• 4.10 慎用 console.log
• 結尾

web前端開發(fā)中，適當?shù)囊?guī)范和標準絕不是消滅代碼內容的創(chuàng)造性、優(yōu)雅性,而是限制過度個性化，以一種普遍認可的統(tǒng)一方式,提升協(xié)作效率,降低溝通成本。規(guī)范的目的是為了編寫高質量的代碼。

1.命名規(guī)范

1.1  項目命名

全部采用小寫方式，以中線分隔。
正例：mall-management-system
反例：mall_management-system / mallManagementSystem

1.2  目錄命名

全部采用小寫方式， 以中劃線分隔，有復數(shù)結構時，要采用復數(shù)命名法， 縮寫不用復數(shù)。

正例： scripts / styles / components / images / utils / layouts / demo-styles / demo-scripts / img / doc
反例： script / style / demo_scripts / demoStyles / imgs / docs
【特殊】VUE 的項目中的 components 中的組件目錄，使用 kebab-case 命名。
正例： head-search / page-loading / authorized / notice-icon
反例： HeadSearch / PageLoading
【特殊】VUE 的項目中的除 components 組件目錄外的所有目錄也使用 kebab-case 命名。
正例： page-one / shopping-car / user-management
反例： ShoppingCar / UserManagement

1.3 JS 、CSS 、SCSS 、HTML 、PNG  文件命名

全部采用小寫方式， 以中劃線分隔。
正例： render-dom.js / signup.css / index.html / company-logo.png
反例： renderDom.js / UserManagement.html

1.4  命名嚴謹性

代碼中的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。 說明：正確的英文拼寫和語法可以讓閱讀者易于理解，避免歧義。注意，即使純拼音命名方式也要避免采用
正例：henan / luoyang / rmb 等國際通用的名稱，可視同英文
反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3
杜絕完全不規(guī)范的縮寫，避免望文不知義：
反例：AbstractClass “縮寫”命名成 AbsClass；condition “縮寫”命名成 condi，此類隨意縮寫嚴重降低了代碼的可閱讀性。

2.HTML規(guī)范

2.1 HTML  類型

推薦使用 HTML5 的文檔類型申明：（建議使用 text/html 格式的 HTML。避免使用 XHTML。XHTML 以及它的屬性，比如application/xhtml+xml 在瀏覽器中的應用支持與優(yōu)化空間都十分有限）。

2.2  縮進

縮進使用 2 個空格（一個 tab）；
嵌套的節(jié)點應該縮進。

2.3  分塊注釋

在每一個塊狀元素，列表元素和表格元素后，加上一對 HTML 注釋。

2.4  語義化標簽

HTML5 中新增很多語義化標簽，所以優(yōu)先使用語義化標簽，避免一個頁面都是 div 或者 p 標簽。

正例
<header></header>
<footer></footer>
反例
<div>
<p></p>
</div>

2.5  引號

使用雙引號(" ") 而不是單引號(’ ') 。 

3 CSS  規(guī)范

3.1  命名

類名使用小寫字母，以中劃線分隔
id 采用駝峰式命名
scss 中的變量、函數(shù)、混合、placeholder 采用駝峰式命名
ID 和 class 的名稱總是使用可以反應元素目的和用途的名稱，或其他通用的名稱，代替表象和晦澀難懂的名稱。

3.2  選擇器

1) css  選擇器中避免使用標簽名

從結構、表現(xiàn)、行為分離的原則來看，應該盡量避免 css 中出現(xiàn) HTML 標簽，并且在 css 選擇器中出現(xiàn)標簽名會存在潛在的問題。

2)  使用 直接子選擇器

很多前端開發(fā)人員寫選擇器鏈的時候不使用 直接子選擇器（注：直接子選擇器和后代選擇器的區(qū)別）。有時，這可能會導致疼痛的設計問題并且有時候可能會很耗性能。然而，在任何情況下，這是一個非常不好的做法。如果你不寫很通用的，需要匹配到 DOM 末端的選擇器， 你應該總是考慮直接子選擇器。

3.3  盡量使用縮寫屬性

不推薦：

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;

3.4  每個選擇器及屬性獨占一行

不推薦：

button {
width: 100px;
height: 50px;
color: #fff;
background: #00a0e9;
}

推薦：

button {
width: 100px;
height: 50px;
color: #fff;
background: #00a0e9;
}

3.5  省略 0  后面的單位

div {
padding-bottom: 0;
margin: 0;
}

3.6  避免使用 ID  選擇器及全局標簽選擇器防止污染全局樣式

不推薦：

#header {
padding-bottom: 0px;
margin: 0em;
}

4 Javascript  規(guī)范

4.1  命名

1) 采用小寫駝峰命名 lowerCamelCase，  代碼中的命名均不能以下劃線 ，也不能以下劃線或美元符號結束

反例： _name / name_ / name$

2)  方法名、參數(shù)名、 成員變量、局部變量都統(tǒng)一使用 lowerCamelCase 風格，必須遵從駝峰形式

正例： localValue / getHttpMessage() / inputUserId
*中 其中 method 是 方法命名必須是 詞 動詞 者 或者  動詞+詞 名詞  形式*
正例：saveShopCarData /openShopCarInfoDialog
反例：save / open / show / go

3)  常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚 ，不要嫌名字長

正例： MAX_STOCK_COUNT
反例： MAX_COUNT

4.2  代碼格式

1) 用 使用 2  個空格進行縮進

2)  不同邏輯 、 不同語義 、 不同業(yè)務的代碼之間插入一個空行分隔開來以提升可讀性

說明：任何情形，沒有必要插入多個空行進行隔開。

4.3  字符串

統(tǒng)一使用單引號(‘)，不使用雙引號(“)。這在創(chuàng)建 HTML 字符串非常有好處：

4.4  對象聲明

1)  使用字面值創(chuàng)建對象

正例： let user = {};
反例： let user = new Object();

2)  使用字面量來代替對象構造器

正例：
var user = {
age: 0,
name: 1,
city: 3
};
反例：
var user = new Object();
user.age = 0;
user.name = 0;
user.city = 0;

4.5 用 使用 ES6+

必須優(yōu)先使用 ES6+ 中新增的語法糖和函數(shù)。這將簡化你的程序，并讓你的代碼更加靈活和可復用。比如箭頭函數(shù)、await/async ， 解構， let ， for…of 等等。

4.6  括號

下列關鍵字后必須有大括號（即使代碼塊的內容只有一行）：if, else, for, while, do, switch, try, catch,finally, with。

正例：
if (condition) {
doSomething();
}
反例：
if (condition) doSomething();

4.7 undefined  判斷

永遠不要直接使用 undefined 進行變量判斷；使用 typeof 和字符串’undefined’對變量進行判斷。

正例：
if (typeof person === 'undefined') {
...
}
反例：
if (person === undefined) {
...
}

4.8  條件判斷和循環(huán)最多三層

條件判斷能使用三目運算符和邏輯運算符解決的，就不要使用條件判斷，但是謹記不要寫太長的
三目運算符。如果超過 3 層請抽成函數(shù)，并寫清楚注釋。

4.9 this  的轉換命名

對上下文 this 的引用只能使用 ’self’ 來命名。

4.10 慎用 console.log

因 console.log 大量使用會有性能問題，所以在非 webpack 項目中謹慎使用 log 功能。

結尾

到此這篇關于阿里前端開發(fā)中的規(guī)范要求的文章就介紹到這了,更多相關阿里前端規(guī)范內容請搜索以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持！