Javascript代码及注释规范
Javascript代码及注释规范
为规范前端开发代码，提高代码质量，特制定此文档，其中声明，安全和分号这三节是必须执行的，组件类必须遵循注释规范。
声明
变量声明必须加var关键字，严格控制作用域；
建议使用驼峰式命名变量和函数，如：functionNamesLikeThis, variableNamesLikeThis, ClassNamesLikeThis,namespaceNamesLikeThis；
私有成员变量和方法命名以下划线开头，如：var _this；
常量定义单词全部大写，以下划线连接，但不要用const关键字来声明，如：SOME_CONSTANTS；
函数参数大于3个时，应以对象形式作为参数集传递；
禁止在代码块中声明函数，错误的范例：if (true) {function foo() {}}；
禁止用new来实例化基本类型，错误的范例：var x = new Boolean(false)；
直接定义数组或对象，而不使用new关键字声明，错误的范例：var a = new Array();var o = new Object()；
使用单引号来定义字符串；
文件名必须全部用小写，文件名分隔符用中划线连接，版本连接符用实心点，合并文件的文件名连接符用下划线，如：passport-core.min.js和reset-1.0_utils-1.0.css；
安全
审查用户输入，如：从URL获取参数，使用跳转页面的referer，用于eval或DOM操作的用户数据；
禁止通过在iframe使用script进行跨域回调；
警惕jquery xss，禁止这样的写法：$(window.location.hash)；
禁止引用站外资源；
分号
函数表达式（有别于函数声明，如：function x(){}）必须用分号结束，下面是错误的范例，第三行漏掉分号，后面的函数被当作参数传递给myMethod，导致解析错误：
var myMethod = function() {
return 42;
}
(function() {
// 一个匿名函数，在这里会被错误解析当作参数调用导致报错
})();
异常
由于无法完美的控制都不出现异常，所以尽量在可能但不确定出现异常的地方（大量运算，AJAX请求，数组操作或DOM操作等）用try-catch(e)来抛出异常，这样有利于规模较大的项目中排查错误。使用自定义异常抛出错误信息，更有利于错误信息阅读，且更加通用，因为不同浏览器抛出的信息不一样，有时候可能很难定位到问题所在位置，特别是IE下可能遇到的如下报错信息：
Stack overflow at line: 0 或： 未知的运行时错误
标准化代码编写
为获取最大化的可移植性和兼容性，代码中应使用标准中支持的方式来书写代码，虽然浏览器支持某些语法但不在规范中，你无法保证你将来不会遇到兼容其他浏览器的情况，如果这个浏览器完全或部分特性只按规范实现。
//错误的范例
var char = 'hello world'[3];
var myForm = document.myForm;
//正确的写法
var char = 'hello world'.charAt(3)
var myForm = document.forms[0];或者var myForm = document.getElementsByTagName('form')[0];
面向对象编程
类中的成员变量使用构造函数来初始化；
除非是必须移除类的成员，否则析构函数中对成员的销毁应通过将其设置为null，而不是用delete，因为重新赋值方式性能比用delete好；
避免通过prototype方式污染内置对象原型链；
作用域相关
不使用with关键字，容易造成作用域混乱；
this仅用于类成员函数或对象中；
通用全局函数，特别是通用组件代码应将业务逻辑放入闭包中，并通过“命名空间”将其引入；
若函数中使用到全局变量，则访问全局变量时应使用window来引入，如：
var somevar = 10； function getvar(){ var num = window.somevar + 1; //... return num; }
杂项
尽量使用优雅的模版写法，避免多行字符串用\加换行的方式或使用+运算连接字符串这种难维护的编码方式；
禁止使用IE条件编译@cc_on；
格式化代码
没有强制要求代码需格式化成什么样子，但尽量使代码具有较高的可读性。下面给出一些建议的代码风格：
// 花括号起始位置与语句开始在同一行
if (something) {
// ...
} else {
// ...
}
// 数组和对象书写
var arr = [1, 2, 3]; // [之后，]之前没有空格
var obj = {a: 1, b: 2, c: 3}; // {之后，}之前没有空格
// 多行数组和对象书写
var a = [
'huangrongrong',
'chenying',
'small grey grey',
'shenshunlin'
];
var pos = {
top: 10,
right: 20,
bottom: 15,
left: 12
};
// 将业务逻辑相关的代码写一起，不相关的以空行分隔
doSomethingTo(x);
doSomethingElseTo(x);
andThen(x);
nowDoSomethingWith(y);
andNowWith(z);
var x = a ? b : c; // 一行能写完
// 写不完可以换行加缩进
var y = a ?
longButSimpleOperandB : longButSimpleOperandC;
// 或者这样
var z = a ?
moreComplicatedB :
moreComplicatedC;
类型转换
对于代码中需要进行==逻辑判断的变量，建议进行强制类型转换或使用===代替。
下列值在布尔表达式中结果为false：
null
undefined
'' //空字符串
0 //数字
而下面的为true：
'0' //字符串
[] //空数组
{} //空对象
还有一些难以区分的表达式，以下表达式结果全为true：
Boolean('0') == true
'0' != true
0 != null
0 == []
0 == false
Boolean(null) == false
null != true
null != false
Boolean(undefined) == false
undefined != true
undefined != false
Boolean([]) == true
[] != true
[] == false
Boolean({}) == true
{} != true
{} != false
注释规范
文档注释遵循YUIDoc规范（http://yui.github.io/yuidoc/syntax/），所有的文件、类、方法和属性都应该用合适的标记和类型进行注释。
YUIDoc要求文档中至少要有一个class和constructor标记来定义类和构造函数；
YUIDoc中注释块必须以/**（至少两个星号）开头；
方法、参数和返回值等必须有注释说明；
单行注释使用//；
对于代码中特殊用途的变量、存在临界值、函数中使用的hack、使用了某种算法或思路等需要进行注释描述；
建议加入开发者个人信息及最后修改时间注释，虽然这些信息不会被YUIDoc解析显示；
下面给出代码注释实例作为参考，更多标记和类型定义请参考YUIDoc官方文档。
/** 这是一个UELib类 @class UELib @constructor @author hiwanz <[email protected]> @modified someone @date 2013-06-25 **/ function UELib = function(){}; /** My method description. Like other pieces of your comment blocks, this can span multiple lines. @method css @param prop {String} set/get a css property @param [value] {String} A value you want to set to a css property @example ele.css('width', '100%'); @return {Boolean} Returns true on success **/ UELib.prototype.css = function(prop,value){ };
代码发布
待定
参考文档
http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
http://www.w3.org/TR/DOM-Level-2-HTML/html.html
JSHint配置
目前规范还无法完全自动化审查，团队根据实际情况，在不与规范冲突的前提下，使用JSHint进行审查，配置文件如下：
{
"jquery": true,//检查预定义的全局变量，防止出现$未定义，该项根据实际代码修改
"bitwise": false,//不检查位运算
"browser": true,//通过浏览器内置的全局变量检测
"devel":true,//允许对调试用的alert和console.log的调用
"camelcase": false,//不强制验证驼峰式命名
"curly": true,//强制使用花括号
"eqeqeq": false,//不强制使用===比较运算符
"es3":true,//兼容es3规范，针对旧版浏览器编写的代码
"esnext": false, //不使用最新的es6规范
"expr": true,//允许未赋值的函数名表达式，例如console && console.log(1)
"forin":false,//不强制过滤遍历对象继承的属性
"freeze":false,//不限制对内置对象的扩展
"immed": true,//禁止未用括号包含立即执行函数
"indent": false,//不强制缩进
"latedef": true,//禁止先调用后定义
"maxdepth":false,//不限制代码块嵌套层数
"maxparams":false,//不限制函数参数个数
"newcap": false,//不对首字母大写的函数强制使用new
"noarg": false,//不禁止对arguments.caller和arguments.callee的调用
"noempty":false,//不禁止空代码块
"nonew":false,//允许直接new实例化而不赋值给变量
"plusplus":false,//允许++和--运算符使用
"quotmark": "single",//字符串使用单引号
"scripturl": true,//允许javascript伪协议的url
"smarttabs": true,//允许混合tab和空格缩进
"strict": false,//不强制使用es5严格模式
"sub": true,//允许用[]形式访问对象属性
"undef": true,//禁止明确未定义的变量调用，如果你的变量（myvar）是在其他文件中定义的，可以使用/*global myvar */绕过检测
"unused": false,//允许定义没用的变量，在某些函数回调中，经常出现多个参数，但不一定会用
"multistr": false,//禁止多行字符串，改用加号连接
"globals": {
"jQuery": true
}
}