Dojo Javascript 编程规范 规范自己的JavaScript书写
前言
良好的JavaScript书写习惯的优点不言而喻,今天彬Go向大家推荐Dojo Javascript 编程规范,相当不错的 Javascript 编程风格规范,建议大家可以借鉴一下此规范编写 Javascript。感谢i.feelinglucky的翻译。
序
Any violation to this guide is allowed if it enhances readability.
所有的代码都要变成可供他人容易阅读的。
快读参考
核心 API 请使用下面的风格:
结构 | 规则 | 注释 |
模块 | 小写 | 不要使用多重语义(Never multiple words) |
类 | 骆驼 | |
公有方法 | 混合 | 其他的外部调用也可以使用 lower_case(),这样的风格 |
公有变量 | 混合 | |
常量 | 骆驼 或 大写 |
下面的虽然不是必要的,但建议使用:
结构 | 规则 |
私有方法 | 混合,例子:_mixedCase |
私有变量 | 混合,例子:_mixedCase |
方法(method)参数 | 混合,例子:_mixedCase, mixedCase |
本地(local)变量 | 混合,例子:_mixedCase, mixedCase |
命名规范
1.变量名称 必须为 小写字母。
2.类的命名使用骆驼命名规则,例如:
Account, EventHandler
3.常量 必须 在对象(类)或者枚举变量的前部声明。枚举变量的命名必须要有实际的意义,并且其成员 必须 使用骆驼命名规则或使用大写:
var NodeTypes = {
Element : 1,
DOCUMENT: 2
}
4.简写单词 不能使用 大写名称作为变量名:
getInnerHtml(), getXml(), XmlDocument
5.方法的命令 必须 为动词或者是动词短语:
obj.getSomeValue()
6.公有类的命名 必须 使用混合名称(mixedCase)命名。
7.CSS 变量的命名 必须 使用其对应的相同的公共类变量。
8.私有类的变量属性成员 必须 使用混合名称(mixedCase)命名,并前面下下划线(_)。例如:
var MyClass = function(){
var _buffer;
this.doSomething = function(){
};
}
9.变量如果设置为私有,则前面 必须 添加下划线。
this._somePrivateVariable = statement;
10.通用的变量 必须 使用与其名字一致的类型名称: