目录
Code Guide by VsurPano Team
最佳原则
- 坚持指定整齐划一的代码规范。
- 无论团队人数多少，代码应该同出一门。
本文档如有不对或者不合适的地方请及时的提出，经过讨论后方可更改
命名规则
项目命名
全部采用小写方式，以下划线分隔。
例：vsur_pano目录命名
参照项目命名规则；
有复数结构时，要采用复数命名法。 例：scripts,styles,images,data_modelsJS文件命名
参照项目命名规则；
例：在baseMap文件夹下的csstool.js需要命名为baseMap_csstool.jsCSS文件命名
参照项目命名规则；
例：basemap_color.css,basemap_layout.css,basemap_typograpy.cssHTML文件命名
参照项目命名规则；
例：basemap_index.htmlHTML
语法
- 缩进使用table（四个空格）;
- 嵌套的节点应该缩进;
- 在属性上，使用双引号，不要使用单引号；
- 属性名全小写，用中划线做分隔符；
不能忽略关闭标签，例：
</li>和</body>。
Page title 
Hello,world
HTML5 doctype
在页面开头使用doctype来启用标准模式，使其在每个浏览器中尽可能一致的展现按照惯例，doctype大写
...
字符编码
通过声明一个明确的字符编码，让浏览器轻松、快速的确定适合网页内容的渲染方式，通常指定为'UTF-8'。
引入CSS,JS
- 根据HTML5规范，通常在引用CSS和JS时不需要指明
type，因为text/css和text/javascript分别是他们的默认值； - 根据结构，显示，控制分层的原则，CSS，JS尽量使用外部文件。CSS文件通过文档的
<head>部分用一个<link>标签引用这个文件<script>标签放到HTML文档的最后，</body>标签之前。
Just a test ...
属性顺序
属性应该按照特定的顺序出现以保证易读性
classidnamedata-*src,for,type,href,value,max-length,max,min,patternplaceholder,title,altaria-*,rolerequired,readonly,disableclass 是为高可复用组件设计的，所以应处在第一位； id 更加具体，针对性更强，原则上应该减少使用，所以放在第二位。
Example link
JS生成标签
在JS文件中生成标签让内容变得更难查找，更难编辑，性能更差。
除了动态生成标签功能外，原则上应该尽量避免这种情况的出现。减少标签数量
在编写HTML代码时，需要尽量避免多余的父节点；
很多时候，需要通过迭代和重构来使HTML变得更少。实用高于完美
尽量遵循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有两种支持的取值1—表示x2—表示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 goodvar x = "test";// goodvar y = 'foo', z = ' ';
变量命名
变量命名遵循以下标准：
- 标准变量采用驼峰式命名（除了对象的属性外，主要是考虑到cgi返回的数据）
- 'ID'在变量名中全大写
- 'URL'在变量名中全大写
- 常量全大写，用下划线连接
- 构造函数，大写第一个字母
- jquery对象必须以'$'开头命名
var thisIsMyName;var goodID;var reportURL;var MAX_COUNT = 10;function Person(name) { this.name = name;}// not goodvar body = $('body');// goodvar $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 gooddoSomething (item);// gooddoSomething(item);// requires parentheses around immediately invoked function expressions(function() { return 1;})();// not good[1, 2].forEach(function x() { ...});// good[1, 2].forEach(function() { ...});// not goodvar a = [1, 2, function a() { ...}];// goodvar a = [1, 2, function() { ...}];// use ', ' between function parametersvar doSomething = function(a, b, c) { // do something}; 数组、对象
对象属性名不需要加引号；
对象以缩进的形式书写，不要写在一行； 数组、对象最后不要有逗号。// not goodvar a = { 'b': 1};var a = {b: 1};var a = { b: 1, c: 2,};// goodvar a = { b: 1, c: 2}; 括号
下列关键字后必须有大括号（即使代码块的内容只有一行）：if , else, for, while, do, switch, try, catch, finally, with。
// not goodif (condition) doSomething();// goodif (condition) { doSomething();} null
适用场景：
- 初始化一个将来可能被赋值为对象的变量
- 与已经初始化的变量做比较
- 作为一个参数为对象的函数的调用传参
- 作为一个返回对象的函数的返回值
不适用场景：
- 不要用null来判断函数调用时有无传参
- 不要与未初始化的变量做比较
// not goodfunction test(a, b) { if (b === null) { // not mean b is not supply ... }}var a;if (a === null) { ...}// goodvar a = null;if (a === null) { ...} undefined
永远不要直接使用undefined进行变量判断；
使用typeof和字符串'undefined'对变量进行判断。// not goodif (person === undefined) { ...}// goodif (typeof person === 'undefined') { ...} 简单类型转换
number to string的转换，建议使用 1 + ''或String(1)，不使用new String(1)或1.toString()的方式。
parseInt，必须显式指定第二个参数的进制。 float to integer的转换，建议使用Math.floor/Math.round/Math.ceil方法，不使用parseInt。 // not goodparseInt('08'); // 0 // goodparseInt('08', 10); //8 jshint
用'===', '!=='代替'==', '!='；
for-in里一定要有hasOwnProperty的判断； 不要在内置对象的原型上添加方法，如Array, Date； 不要在内层作用域的代码里声明了变量，之后却访问到了外层作用域的同名变量； 变量不要先使用后声明； 不要在一句代码中单单使用构造函数，记得将其赋值给某个变量； 不要在同个作用域下声明同名变量； 不要在一些不需要的地方加括号，例：delete(a.b)； 不要使用未声明的变量（全局变量需要加到.jshintrc文件的globals属性里面）； 不要声明了变量却不使用； 不要在应该做比较的地方做赋值； debugger不要出现在提交的代码里； 数组中不要存在空元素； 不要在循环内部声明函数； 不要像这样使用构造函数，例：new function () { ... }, new Object；// not goodif (a == 1) { a++;}// goodif (a === 1) { a++;}// goodfor (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 goodArray.prototype.count = function(value) { return 4;};// not goodvar x = 1;function test() { if (true) { var x = 0; } x += 1;}// not goodfunction test() { console.log(x); var x = 1;}// not goodnew Person();// goodvar person = new Person();// not gooddelete(obj.attr);// gooddelete obj.attr;// not goodif (a = 10) { a++;}// not goodvar a = [1, , , 2, 3];// not goodvar nums = [];for (var i = 0; i < 10; i++) { (function(i) { nums[i] = function(j) { return i + j; }; }(i));}// not goodvar 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 goodvar a = 1;function Person() { // not good var me = this; // good var _this = this; // good var that = this; // good var self = this;}// goodswitch (condition) { case 1: case 2: ... break; case 3: ... // why fall through case 4 ... break; // why no default}// not good with empty blockif (condition) {}