Web前端代碼規範

HTML

原則
1.規範 。保證您的代碼規範，保證結構表現行爲相互分離。
2.簡潔。保證代碼的最簡化，避免多餘的空格、空行，保持代碼的語義化，儘可能使用具備語義的元素，避免使用樣式屬性和行爲屬性。任什麼時候候都要用盡可能簡單、儘可能少的元素解決問題。
3.實用。遵循標準，可是不能以犧牲實用性爲代價。
4.忠誠。選擇一套規範，而後始終遵循。無論代碼由多少人蔘與，都應該看起來像一我的寫的同樣

語法
1.小寫. html標籤、屬性所有小寫。
2.嵌套. 全部元素必須正確嵌套。
3.閉合. 雙標籤必須閉合，單標籤（自關閉標籤）不閉合 如 <hr>。
4.雙引號. 雙引號屬性值，不要使用單引號。

註釋
1.詳盡註釋。解釋代碼解決問題、解決思路等。
2.模塊註釋。建議不使用模塊結束註釋。

文檔
1.文檔類型使用html5標準文檔類型，文檔類型聲明以前，不容許出現任何非空字符。不容許添加<meta>強制改變文檔模式。
2.html元素上指定lang屬性。顯示頁面語言，有助於語言合成工具來肯定怎樣發音，以及翻譯工具決定使用的規則，等等。
3.指定明確的字符編碼。讓瀏覽器輕鬆、快速的肯定適合網頁內容的渲染方式。

屬性
1.雙引號屬性值，不要使用單引號。
2.省略type屬性。使用style、link、script，不用指定type屬性，由於 text/css 和 text/javascript 分別是他們的默認值。
3.省略Boolean屬性值。Boolean屬性不用添加取值，disabled,checked,selected等。
4.省略url類屬性資源協議頭。
5.屬性順序。html屬性應該按照特定的順序出現以保證易讀性。class->id,name->data-*->src,for,type,href->title,alt->aria-*,role。
6.多媒體元素添加替代屬性。圖像增長alt屬性，音視頻增長替代文字。

元素
1.避免冗餘標籤。
2.避免JS生成標籤。
3.段落文字應該用p，避免使用br。
4.列表項放ul,ol,dl,不要使用一系列的div或p。
5.input使用for屬性綁定label。
6.使label標籤包裹radio或checkbox和他們的文字，不用再使用for屬性。
8.form button應制定type類型，使用type="submit"、type="reset"或type="button"。

參考: http://www.php100.com/html/it/qianduan/2015/0116/8389.html

CSS

全局：global.css

全局樣式爲全站公用，爲頁面樣式基礎，頁面中必須包含。

結構：layout.css

頁面結構類型複雜，而且公用類型較多時使用。多用在首頁級頁面和產品類頁面中。

私有：style.css

獨立頁面所使用的樣式文件，頁面中必須包含。

模塊 module.css

產品類頁面應用，將可複用類模塊進行剝離後，可與其它樣式配合使用。

主題 themes.css

實現換膚功能時應用。

補丁 mend.css 基於以上樣式進行的私有化修補。

CSS命名規範
頭：header
內容：content/containe
尾：footer
導航：nav
側欄：sidebar
欄目：column
頁面外圍控制總體佈局寬度：wrapper
左右中：left right center
登陸條：loginbar
標誌：logo
廣告：banner
頁面主體：main
熱點：hot
新聞：news
下載：download
子導航：subnav
菜單：menu
子菜單：submenu
搜索：search
友情連接：friendlink
頁腳：footer
版權：copyright
滾動：scroll
內容：content
標籤頁：tab
文章列表：list
提示信息：msg
小技巧：tips
欄目標題：title
加入：joinus
指南：guild
服務：service
註冊：regsiter
狀態：status
投票：vote
合做夥伴：partner

1.命名統一採用小寫
注意事項::
一概小寫;
儘可能用英文;
不加中槓和下劃線;
儘可能不縮寫，除非一看就明白的單詞.

class的命名:

(1)顏色:使用顏色的名稱或者16進制代碼,如
.red { color: red; }
.f60 { color: #f60; }
.ff8600 { color: #ff8600; }

（2）字體大小,直接使用」font+字體大小」做爲名稱,如
.font12px { font-size: 12px; }
.font9pt {font-size: 9pt; }

(3)對齊樣式,使用對齊目標的英文名稱,如
.left { float:left; }
.bottom { float:bottom; }

(4)標題欄樣式,使用」類別+功能」的方式命名,如
.barnews { }
.barproduct { }


XHTML文件中id的命名

(1)頁面結構
容器: container
頁頭：header
內容：content/container
頁面主體：main
頁尾：footer
導航：nav
側欄：sidebar
欄目：column
頁面外圍控制總體佈局寬度：wrapper
左右中：left right center 
(2)導航
導航：nav
主導航：mainbav
子導航：subnav
頂導航：topnav
邊導航：sidebar
左導航：leftsidebar
右導航：rightsidebar
菜單：menu
子菜單：submenu
標題: title
摘要: summary 
(3)功能
標誌：logo
廣告：banner
登錄：login
登陸條：loginbar
註冊：regsiter
搜索：search
功能區：shop
標題：title
加入：joinus
狀態：status
按鈕：btn
滾動：scroll
標籤頁：tab
文章列表：list
提示信息：msg
當前的: current
小技巧：tips
圖標: icon
註釋：note
指南：guild
服務：service
熱點：hot
新聞：news
下載：download
投票：vote
合做夥伴：partner
友情連接：link
版權：copyright

參考：http://www.qianduan.net/css-selectors-naming-2/
　

 

Javascript:

使用駝峯標記法
首字母是小寫的，接下來的字母都以大寫字符開頭。例如：
var testValue = 0, secondValue = "hi";

不要使用 switch
switch 在全部的編程語言中都是個很是錯誤的難以控制的語句，建議用 if else 來替換它。

操做符（+，-，*，/，%）先後請加空格
例如
return x + y;

縮進
使用兩個空格來代替tab

字符串
統一使用單引號(‘)，不使用雙引號(「)。這在建立 HTML 字符串很是有好處：

三元條件判斷（if 的快捷方法）
用三元操做符分配或返回語句。在比較簡單的狀況下使用，避免在複雜的狀況下使用。沒人願意用 10 行三元操做符把本身的腦子繞暈。

不推薦
if(x === 10) {
return 'valid';
} else {
return 'invalid';
}
推薦
return x === 10 ? 'valid' : 'invalid';

澄清：分號與函數
分號須要用在表達式的結尾，而並不是函數聲明的結尾。區分它們最好的例子是：
var foo = function() {
return true;
}; // semicolon here.

function foo() {
return true;
} // no semicolon here.


參考：http://www.css88.com/archives/5366

 

友情連接： https://www.aliyun.com/jiaocheng/636938.html