相關(guān)文章
博客原文
我的前端規(guī)范——開篇
我的前端規(guī)范——HTML篇
我的前端規(guī)范——CSS篇
我的前端規(guī)范——JavaScript篇
大綱
前言
1、命名規(guī)范
2、編碼規(guī)則
前言
規(guī)范對于一個項目來說是很重要的,統(tǒng)一的規(guī)范對代碼的一致性、項目的質(zhì)量、工作的協(xié)調(diào)都有很大的幫助,而且有時候可以規(guī)避很多意料不到的錯誤。
當然,規(guī)范是死的,人是活的。我總結(jié)的前端規(guī)范是我認為對我來說比較適合的,我又認可的,所以我能比較好的接受和使用。但是,不同的團隊,不同的項目需要遵守的規(guī)范也許就是不一樣的。規(guī)范的作用是讓項目的代碼看起來更有統(tǒng)一性,讓團隊的協(xié)作更方便,因此,根據(jù)具體的情況制定統(tǒng)一的規(guī)范才是最合理的,而這里我給出的也只是我認為比較符合我風(fēng)格和習(xí)慣的,至于具體的規(guī)范還是要依據(jù)具體的情況來總結(jié)制定。
單獨寫成一篇的話篇幅很大,因此我會將我的總結(jié)寫成:開篇、css、html、js四篇,讓有需要的讀者能夠更方便的查找到想要的知識。
1、命名規(guī)范
1.1、文件命名可讀性強
文件夾、文件的命名與命名空間應(yīng)能代表代碼功能,可讀性強。
1.2、函數(shù)命名
駝峰命名方式,函數(shù)名字應(yīng)體現(xiàn)出該函數(shù)的作用
function funName() {}
1.3、常量
大寫
var VARIABLENAME
1.4、變量
駝峰命名
變量名應(yīng)體現(xiàn)出該變量的內(nèi)容
通過加下劃線體現(xiàn)其局部變量的含義,如 let _name;
var variableName
2、編碼規(guī)則
2.1、排版縮進
采用統(tǒng)一的縮進方式排版代碼。縮進必須是軟tab(用空格字符)。(這里的tab的要求是4個空格)
2.2、關(guān)鍵詞、條件括弧后面使用空格;運算操作符號兩側(cè)使用空格;語句分割符‘,’后面使用空格
var name[空格]=[空格]value;
if[空格](a,[空格]b) {
}
2.3、左大括號"{"可以居行尾,也可寫在下行首(獨自一行);右大括號"}"單獨占一行,居行首
if (a && b) {
}
------------------------
if (a && b)
{
}
2.4、句末必須用分號結(jié)尾
var fn = function () {
};//這里沒有分號的話,腳本解析器會報錯!!!
(function () {
alert(1);
})();
2.5、單行過長應(yīng)在適當位置予以換行,增強可讀性
if 語句括號中的條件若過多過長,應(yīng)予以折行;折行后,||、&& 等符號應(yīng)與 “(” 后的第一個字母縱向?qū)R
if (condition1
&& condition2
|| condition3) {
}
2.6、if、while、for、do語句的執(zhí)行體總是用"{"和"}"括起來,即使在其結(jié)構(gòu)體內(nèi)只有一條語句
if (s==100) {
alert('shit!');
}
2.7、語法意義相互獨立的代碼將用空行分隔
a++; b++; //!!!避免同一行書寫兩個表達式
if (a > b) {
value = a; //行間不用空行間隔
}
var variableName = value; //與上一代碼行使用空行間隔