标签: 杂谈 | 分类:javascript |
转自http://blog.bingo929.com/dojo-javascript-style-guide.html 前言 良好的JavaScript书写习惯的优点不言而喻,今天彬Go向大家推荐Dojo Javascript 编程规范,相当不错的Javascript 编程风格规范,建议大家可以借鉴一下此规范编写Javascript。感谢i.feelinglucky的翻译。 序 Any violation to this guide isallowed if it enhances readability. 所有的代码都要变成可供他人容易阅读的。 快读参考 核心 API 请使用下面的风格:
命名规范 1.变量名称 必须为 小写字母。
3.常量 必须在对象(类)或者枚举变量的前部声明。枚举变量的命名必须要有实际的意义,并且其成员 必须 使用骆驼命名规则或使用大写:
4.简写单词 不能使用 大写名称作为变量名: getInnerHtml(), 5.方法的命令 必须 为动词或者是动词短语: obj.getSomeValue() 6.公有类的命名 必须 使用混合名称(mixedCase)命名。
var
} 9.变量如果设置为私有,则前面 必须 添加下划线。 this._somePrivateVariable 10.通用的变量 必须 使用与其名字一致的类型名称: setTopic(topic)// 变量 topic 为 Topic 类型的变量 11.所有的变量名 必须 使用英文名称。 getHandler();//避免使用 getEventHandler() 14.公有变量必须清楚的表达其自身的属性,避免字义含糊不清,例如: MouseEventHandler ,而非 MseEvtHdlr。 15.类/构造函数 可以使用 扩展其基类的名称命名,这样可以正确、迅速的找到其基类的名称: 特殊命名规范 术语 “get/set” 不要和一个字段相连,除非它被定义为私有变量。前面加 “is” 的变量名 应该 为布尔值,同理可以为“has”, “can” 或者 “should”。术语 “compute” 作为变量名应为已经计算完成的变量。术语 “find”作为变量名应为已经查找完成的变量。术语 “initialize” 或者 “init”作为变量名应为已经实例化(初始化)完成的类或者其他类型的变量。UI (用户界面)控制变量应在名称后加控制类型,例如:leftComboBox, TopScrollPane。复数必须有其公共的名称约定(原文:Plural form MUST beused to name collections)。带有 “num” 或者 “count”开头的变量名约定为数字(对象)。重复变量建议使用 “i”, “j”, “k” (依次类推)等名称的变量。补充用语必须使用补充词,例如:get/set, add/remove, create/destroy, start/stop, insert/delete,begin/end, etc.能缩写的名称尽量使用缩写。避免产生歧义的布尔变量名称,例如: |