Code Guide by VsurPano Team
最佳原則#
- 堅持指定整齊划一的代碼規范。
- 無論團隊人數多少，代碼應該同出一門。
- 本文檔如有不對或者不合適的地方請及時的提出，經過討論后方可更改
命名規則#
項目命名##
全部采用小寫方式，以下划線分隔。
例：vsur_pano
目錄命名##
參照項目命名規則；
有復數結構時，要采用復數命名法。
例：scripts,styles,images,data_models
JS文件命名##
參照項目命名規則；
例：在baseMap文件夾下的csstool.js需要命名為baseMap_csstool.js
CSS文件命名##
參照項目命名規則；
例：basemap_color.css,basemap_layout.css,basemap_typograpy.css
HTML文件命名##
參照項目命名規則；
例：basemap_index.html
HTML#
語法##
- 縮進使用table（四個空格）;
- 嵌套的節點應該縮進;
- 在屬性上，使用雙引號，不要使用單引號；
- 屬性名全小寫，用中划線做分隔符；
- 不能忽略關閉標簽，例：
</li>和</body>。
<!DOCTYPE html>
<html>
<head>
<title>Page title</title>
</head>
<body>
<img src="images/company_logo.png" alt="Company">
<h1 class="hello-world">Hello,world<h1>
</body>
</html>
HTML5 doctype##
在頁面開頭使用doctype來啟用標准模式，使其在每個瀏覽器中盡可能一致的展現按照慣例，doctype大寫
<!DOCTYPE html>
<html>
...
</html>
字符編碼##
通過聲明一個明確的字符編碼，讓瀏覽器輕松、快速的確定適合網頁內容的渲染方式，通常指定為'UTF-8'。
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
</html>
引入CSS,JS##
- 根據HTML5規范，通常在引用CSS和JS時不需要指明
type，因為text/css和text/javascript分別是他們的默認值； - 根據結構，顯示，控制分層的原則，CSS，JS盡量使用外部文件。CSS文件通過文檔的
<head>部分用一個<link>標簽引用這個文件<script>標簽放到HTML文檔的最后，</body>標簽之前。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Just a test</title>
<link rel="stylesheet" href="styles/basemap_layout.css">
</head>
<body>
...
<script src="scripts/basemap_csstool.js"></script>
</body>
</html>
屬性順序##
屬性應該按照特定的順序出現以保證易讀性
classidnamedata-*src,for,type,href,value,max-length,max,min,patternplaceholder,title,altaria-*,rolerequired,readonly,disable
class 是為高可復用組件設計的，所以應處在第一位；
id 更加具體，針對性更強，原則上應該減少使用，所以放在第二位。
<a class="..." id="..." data-modal="toggle" href="#">Example link</a>
<input class="form-control" type="text">
<img src="..." alt="...">
JS生成標簽##
在JS文件中生成標簽讓內容變得更難查找，更難編輯，性能更差。
除了動態生成標簽功能外，原則上應該盡量避免這種情況的出現。
減少標簽數量##
在編寫HTML代碼時，需要盡量避免多余的父節點；
很多時候，需要通過迭代和重構來使HTML變得更少。
<!-- Not well -->
<div class="avatar">
<img src="...">
</div>
<!--Better-->
<img class="avatar" src="...">
實用高於完美##
盡量遵循HTML標准和語義，但是不應該以浪費實用性為代價；
任何時候都要用盡量小的復雜度和盡量小的標簽解決問題。
CSS#
縮進##
使用soft tab（4個空格）
.element {
position: absolute;
top: 10px;
left: 10px;
border-radius: 10px;
width: 50px;
height: 50px;
}
分號##
每個屬性末尾都要加分號。
.element {
position: absolute;
top: 10px;
left: 10px;
}
空格##
以下幾種情況不需要空格：
- 屬性名后
- 多個規則的分隔符','前
!important'!'后- 屬性值中'('后和')'前
- 行末不要有多余的空格
以下幾種情況需要空格：
- 屬性值前
- 選擇器'>','+','~'前后
- '{'前
!important'!'前@else前后- 屬性值中的','后
- 注釋'/*'后和'*/'前
/* not good */
.element {
color :red! important;
background-color: rgba(0,0,0,.5);
}
/* good */
.element {
color: red !important;
background-color: rgba(0, 0, 0, .5);
}
/* not good */
.element ,
.dialog{
...
}
/* good */
.element,
.dialog {
}
/* not good */
.element>.dialog{
...
}
/* good */
.element > .dialog{
...
}
/* not good */
.element{
...
}
/* good */
.element {
...
}
/* not good */
@if{
...
}@else{
...
}
/* good */
@if {
...
} @else {
...
}
空行##
以下幾種情況需要空行：
- 文件最后保留一個空行
- '}'后最好跟一個空行
- 屬性之間需要適當的空行
換行##
以下情況不需要換行：
- '{'前
以下幾種情況需要換行：
- '{'后和'}'前
- 每個屬性獨占一行
- 多個規則的分隔符','后
/* not good */
.element
{color: red; background-color: black;}
/* good */
.element {
color: red;
background-color: black;
}
/* not good */
.element, .dialog {
...
}
/* good */
.element,
.dialog {
...
}
CSS屬性順序##
1 顯示屬性；
2 元素位置；
3 元素屬性；
4 元素內容屬性；
5 css書寫順序：
.header {
/* 顯示屬性 */
display || visibility
list-style
position
top || right || bottom || left
z-index
clear
float
/* 自身屬性 */
width
max-width || min-width
height
max-height || min-height
overflow || clip
margin
padding
outline
border
background
/* 文本屬性 */
color
font
text-overflow
text-align
text-indent
line-height
white-space
vertical-align
cursor
content
}
注釋##
注釋統一用'/**/',具體寫法參照下面的示例；
縮進與下一行代碼保持一致；
可位於一個代碼行的末尾，與代碼間隔一個空格。
/* Modal header */
.modal-header {
...
}
/*
* Modal header
*/
.modal-header {
...
}
.modal-header {
/* 50px */
width: 50px;
color: red; /* color red */
}
引號##
最外層統一使用雙引號；
url的內容要用引號；
屬性選擇器中的屬性值需要引號。
z-index##
自己寫的z-index的值不能超過 100 (通用組的除外);
頁面中的元素內容的z-index不能超過10(popup poptip除外)，需要按照內容定義1 2 3 4不允許直接使用如1000，9999;
popup poptip的z-index需要按照內容使用 99以下，10以上的值（11,12,13，也可以小於10），不允許直接使用1000，9999之類大值;
命名##
類名使用小寫字母，以中划線分隔；
id采用駝峰式命名
scss中的變量、函數、混合、placeholder采用駝峰式命名
/* class */
.element-content {
...
}
/* id */
#myDialog {
...
}
屬性簡寫##
屬性簡寫需要你非常清楚屬性值的正常順序，而且在大多數情況下並不需要設置屬性簡寫中包含的所有值，所以建議盡量分開聲明會更加清晰；
margin 和 padding 相反，需要使用簡寫;
常見的屬性簡寫包括：
fontbackgroundtransitionanimation
/* not good */
.element {
transition: opacity 1s linear 2s;
}
/* good */
.element {
transition-delay: 2s;
transition-timing-function: linear;
transition-duration: 1s;
transition-property: opacity;
}
雜項##
不允許有空的規則；
元素選擇器用小寫字母；
去掉小數點前面的0；
數字不必要的小數點和末尾的0；
同個屬性不同前綴的寫法需要在垂直方向保持對齊，具體參照下面的寫法；
無前綴的標准屬性應該寫在有前綴的屬性后面；
不要在同一個規則例出現重復的屬性，如果重復的屬性是連續的則沒關系；
不要在一個文件里出現兩個相同的規則；
用 broder:0; 代替 broder:none;；
選擇器不要超過4層
盡量少用'*'選擇器。
/* good */
li {
...
}
/* not good */
.element {
color: rgba(0, 0, 0, 0.5);
}
/* good */
.element {
color: rgba(0, 0, 0, .5);
}
/* not good */
.element {
width: 50.0px;
}
/* good */
.element {
width: 50px;
}
/* not good */
.element {
border-radius: 3px;
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
background: linear-gradient(to bottom, #fff 0, #eee 100%);
background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
background: -moz-linear-gradient(top, #fff 0, #eee 100%);
}
/* good */
.element {
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
border-radius: 3px;
background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
background: -moz-linear-gradient(top, #fff 0, #eee 100%);
background: linear-gradient(to bottom, #fff 0, #eee 100%);
}
/* not good */
.element {
color: rgb(0, 0, 0);
width: 50px;
color: rgba(0, 0, 0, .5);
}
/* good */
.element {
color: rgb(0, 0, 0);
color: rgba(0, 0, 0, .5);
}
JavaScript##
縮進##
使用soft tab（4個空格）。
var x = 1,
y = 1;
if (x < y) {
x += 10;
} else {
x += 1;
}
單行長度##
單行長度不要超過80，但如果編輯器開啟word wrap可以不考慮單行長度
分號##
以下幾種情況后需加分號：
- 變量聲明
- 表達式
- return
- throw
- break
- continue
- do-while
/* var declaration */
var x = 1;
/* expression statement */
x++;
/* do-while */
do {
x++;
} while (x < 10);
空格##
以下幾種情況不需要空格：
- 對象屬性名后
- 前綴一元運算符
- 后綴一元運算符
- 函數調用括號前
- 無論是函數聲明還是函數表達式，'('前不要空格
- 數組的'['后和']'前
- 對象的'{'后和'}'前
- 運算符的'('后和')'前
以下幾種情況需要空格
- 二元運算符前后
- 三元運算符'?:'前后
- 代碼塊'{'前
- 下列關鍵字前：
else,while,catch,finally - 下列關鍵字后：
if,else,for,while,do,switch,case,try,catch,finally,with,return,typeof - 單行注釋'//'后（若單行注釋和代碼同行，則'//'前也需要），多行注釋'*'后
- 對象的屬性值前
- for循環，分號后留有一個空格，前置條件如果有多個，逗號后留一個空格
- 無論是函數聲明還是函數表達式，'{'前一定要有空格
- 函數的參數之間
// not good
var a = {
b :1
};
// good
var a = {
b: 1
};
// not good
++ x;
y ++;
z = x?1:2;
// good
++x;
y++;
z = x ? 1 : 2;
// not good
var a = [ 1, 2 ];
// good
var a = [1, 2];
// not good
var a = ( 1+2 )*3;
// good
var a = (1 + 2) * 3;
/*
* no space before '(', one space before '{',
* one space between function parameters
*/
var doSomething = function(a, b, c) {
// do something
};
// no space before '('
doSomething(item);
// not good
for(i=0;i<6;i++){
x++;
}
// good
for (i = 0; i < 6; i++) {
x++;
}
空行##
以下幾種情況需要空行：
- 變量聲明后（當變量聲明在代碼塊的最后一行時，則無需空行）
- 注釋前（當注釋在代碼塊的第一行時，則無需空行）
- 語法意義相互獨立的代碼塊后（在函數調用、數組、對象中則無需空行）
- 文件最后保留一個空行
// need blank line after variable declaration
var x = 1;
// not need blank line when variable declaration is last expression in the current block
if (x >= 1) {
var y = x + 1;
}
var a = 2;
// need blank line before line comment
a++;
function b() {
// not need blank line when comment is first line of block
return a;
}
// need blank line after blocks
for (var i = 0; i < 2; i++) {
if (true) {
return false;
}
continue;
}
var obj = {
foo: function() {
return 1;
},
bar: function() {
return 2;
}
};
// not need blank line when in argument list, array, object
func(
2,
function() {
a++;
},
3
);
var foo = [
2,
function() {
a++;
},
3
];
var foo = {
a: 2,
b: function() {
a++;
},
c: 3
};
換行##
換行的地方，行末必須有','或者運算符；
以下幾種情況不需要換行：
- 下列關鍵字后：
else,catch,finally - 代碼塊'{'前
以下幾種情況需要換行：
- 代碼塊'{'后和'}'前
- 變量賦值后
// not good
var a = {
b: 1
, c: 2
};
x = y
? 1 : 2;
// good
var a = {
b: 1,
c: 2
};
x = y ? 1 : 2;
x = y ?
1 : 2;
// no need line break with 'else', 'catch', 'finally'
if (condition) {
...
} else {
...
}
try {
...
} catch (e) {
...
} finally {
...
}
// not good
function test()
{
...
}
// good
function test() {
...
}
// not good
var a, foo = 7, b,
c, bar = 8;
// good
var a,
foo = 7,
b, c, bar = 8;
單行注釋##
雙斜線后，必須跟一個空格；
縮進與下一行代碼保持一致；
可位於一個代碼行的末尾，與代碼間隔一個空格。
if (condition) {
// if you made it here, then all security checks passed
allowed();
}
var zhangsan = 'zhangsan'; // one space after code
多行注釋##
最少三行, '*'后跟一個空格，具體參照右邊的寫法；
建議在以下情況下使用：
- 難於理解的代碼段
- 可能存在錯誤的代碼段
- 瀏覽器特殊的HACK代碼
- 業務邏輯強相關的代碼
/*
* one space after '*'
*/
var x = 1;
文檔注釋##
各類標簽@param, @method等請參考 [usejsdoc][] 和 [JSDocGuide][] ；
[usejsdoc]: http://usejsdoc.org/about-getting-started.html
[JSDocGuide]: http://yuri4ever.github.io/jsdoc/
建議在以下情況下使用：
- 所有常量
- 所有函數
- 所有類
/**
* @func
* @desc 一個帶參數的函數
* @param {string} a - 參數a
* @param {number} b=1 - 參數b默認值為1
* @param {string} c=1 - 參數c有兩種支持的取值</br>1—表示x</br>2—表示xx
* @param {object} d - 參數d為一個對象
* @param {string} d.e - 參數d的e屬性
* @param {string} d.f - 參數d的f屬性
* @param {object[]} g - 參數g為一個對象數組
* @param {string} g.h - 參數g數組中一項的h屬性
* @param {string} g.i - 參數g數組中一項的i屬性
* @param {string} [j] - 參數j是一個可選參數
*/
function foo(a, b, c, d, g, j) {
...
}
引號##
最外層統一使用單引號。
// not good
var x = "test";
// good
var y = 'foo',
z = '<div id="test"></div>';
變量命名##
變量命名遵循以下標准：
- 標准變量采用駝峰式命名（除了對象的屬性外，主要是考慮到cgi返回的數據）
- 'ID'在變量名中全大寫
- 'URL'在變量名中全大寫
- 常量全大寫，用下划線連接
- 構造函數，大寫第一個字母
- jquery對象必須以'$'開頭命名
var thisIsMyName;
var goodID;
var reportURL;
var MAX_COUNT = 10;
function Person(name) {
this.name = name;
}
// not good
var body = $('body');
// good
var $body = $('body');
變量聲明##
一個函數作用域中所有的變量聲明盡量提到函數首部，用一個var聲明，不允許出現兩個連續的var聲明。
function doSomethingWithItems(items) {
// use one var
var value = 10,
result = value + 10,
i,
len;
for (i = 0, len = items.length; i < len; i++) {
result += 10;
}
}
函數##
無論是函數聲明還是函數表達式，'('前不要空格，但'{'前一定要有空格；
函數調用括號前不需要空格；
立即執行函數外必須包一層括號；
不要給inline function命名；
參數之間用', '分隔，注意逗號后有一個空格。
// no space before '(', but one space before'{'
var doSomething = function(item) {
// do something
};
function doSomething(item) {
// do something
}
// not good
doSomething (item);
// good
doSomething(item);
// requires parentheses around immediately invoked function expressions
(function() {
return 1;
})();
// not good
[1, 2].forEach(function x() {
...
});
// good
[1, 2].forEach(function() {
...
});
// not good
var a = [1, 2, function a() {
...
}];
// good
var a = [1, 2, function() {
...
}];
// use ', ' between function parameters
var doSomething = function(a, b, c) {
// do something
};
數組、對象##
對象屬性名不需要加引號；
對象以縮進的形式書寫，不要寫在一行；
數組、對象最后不要有逗號。
// not good
var a = {
'b': 1
};
var a = {b: 1};
var a = {
b: 1,
c: 2,
};
// good
var a = {
b: 1,
c: 2
};
括號##
下列關鍵字后必須有大括號（即使代碼塊的內容只有一行）：if , else, for, while, do, switch, try, catch, finally, with。
// not good
if (condition)
doSomething();
// good
if (condition) {
doSomething();
}
null##
適用場景：
- 初始化一個將來可能被賦值為對象的變量
- 與已經初始化的變量做比較
- 作為一個參數為對象的函數的調用傳參
- 作為一個返回對象的函數的返回值
不適用場景：
- 不要用null來判斷函數調用時有無傳參
- 不要與未初始化的變量做比較
// not good
function test(a, b) {
if (b === null) {
// not mean b is not supply
...
}
}
var a;
if (a === null) {
...
}
// good
var a = null;
if (a === null) {
...
}
undefined##
永遠不要直接使用undefined進行變量判斷；
使用typeof和字符串'undefined'對變量進行判斷。
// not good
if (person === undefined) {
...
}
// good
if (typeof person === 'undefined') {
...
}
簡單類型轉換##
number to string的轉換，建議使用 1 + ''或String(1)，不使用new String(1)或1.toString()的方式。
string to number的轉換，建議使用parseInt，必須顯式指定第二個參數的進制。
float to integer的轉換，建議使用Math.floor/Math.round/Math.ceil方法，不使用parseInt。
// not good
parseInt('08'); // 0
// good
parseInt('08', 10); //8
jshint##
用'=', '!'代替'==', '!='；
for-in里一定要有hasOwnProperty的判斷；
不要在內置對象的原型上添加方法，如Array, Date；
不要在內層作用域的代碼里聲明了變量，之后卻訪問到了外層作用域的同名變量；
變量不要先使用后聲明；
不要在一句代碼中單單使用構造函數，記得將其賦值給某個變量；
不要在同個作用域下聲明同名變量；
不要在一些不需要的地方加括號，例：delete(a.b)；
不要使用未聲明的變量（全局變量需要加到.jshintrc文件的globals屬性里面）；
不要聲明了變量卻不使用；
不要在應該做比較的地方做賦值；
debugger不要出現在提交的代碼里；
數組中不要存在空元素；
不要在循環內部聲明函數；
不要像這樣使用構造函數，例：new function () { ... }, new Object；
// not good
if (a == 1) {
a++;
}
// good
if (a === 1) {
a++;
}
// good
for (key in obj) {
if (obj.hasOwnProperty(key)) {
// be sure that obj[key] belongs to the object and was not inherited
console.log(obj[key]);
}
}
// not good
Array.prototype.count = function(value) {
return 4;
};
// not good
var x = 1;
function test() {
if (true) {
var x = 0;
}
x += 1;
}
// not good
function test() {
console.log(x);
var x = 1;
}
// not good
new Person();
// good
var person = new Person();
// not good
delete(obj.attr);
// good
delete obj.attr;
// not good
if (a = 10) {
a++;
}
// not good
var a = [1, , , 2, 3];
// not good
var nums = [];
for (var i = 0; i < 10; i++) {
(function(i) {
nums[i] = function(j) {
return i + j;
};
}(i));
}
// not good
var singleton = new function() {
var privateVar;
this.publicMethod = function() {
privateVar = 1;
};
this.publicMethod2 = function() {
privateVar = 2;
};
};
雜項##
不要混用tab和space；
不要在一處使用多個tab或space；
換行符統一用'LF'；
對上下文this的引用只能使用'_this', 'that', 'self'其中一個來命名；
行尾不要有空白字符；
switch的falling through和no default的情況一定要有注釋特別說明；
不允許有空的代碼塊。
// not good
var a = 1;
function Person() {
// not good
var me = this;
// good
var _this = this;
// good
var that = this;
// good
var self = this;
}
// good
switch (condition) {
case 1:
case 2:
...
break;
case 3:
...
// why fall through
case 4
...
break;
// why no default
}
// not good with empty block
if (condition) {
}