javascript命名规则

编程常识 专栏收录该内容
8 篇文章 0 订阅

JavaScript命名规范

(2012-04-01 15:13:22)
标签:

杂谈

分类: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 请使用下面的风格:

结构 规则 注释
模块 小写 不要使用多重语义(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.通用的变量 必须 使用与其名字一致的类型名称:

setTopic(topic)// 变量 topic 为 Topic 类型的变量

11.所有的变量名 必须 使用英文名称。
12.变量如有较广的作用域(largescope),必须使用全局变量;此时可以设计成一个类的成员。相对的如作用域较小或为私有变量则使用简洁的单词命名。
13.如果变量有其隐含的返回值,则避免使用其相似的方法:

getHandler();//避免使用 getEventHandler()

14.公有变量必须清楚的表达其自身的属性,避免字义含糊不清,例如:

MouseEventHandler

,而非 MseEvtHdlr。
  请再次注意这条规定,这样做得的好处是非常明显的。它能明确的表达表达式所定义的含义。

15.类/构造函数 可以使用 扩展其基类的名称命名,这样可以正确、迅速的找到其基类的名称:
 EventHandler
 UIEventHandler
 MouseEventHandler
  基类可以在明确描述其属性的前提下,缩减其命名:
   MouseEventHandler as opposed to MouseUIEventHandler.

特殊命名规范

术语 “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.能缩写的名称尽量使用缩写。避免产生歧义的布尔变量名称,例如:
  isNotError, isNotFound 为非法错误类建议在变量名称后加上 “Exception” 或者“Error”。方法如果返回一个类,则应该在名称上说明返回什么;如果是一个过程,则应该说明做了什么。

3

阅读 (5203) 评论 (0) 收藏 (0) 转载 (2) 喜欢 打印 举报
已投稿到:

转载列表:

    转载

    转载是分享博文的一种常用方式...

    前一篇: js 选项卡
    后一篇: cmd命令
      发评论

      登录名: 密码: 找回密码 注册

      昵   称:

         

      按住左边滑块,拖动完成上方拼图
      点击上图按钮并沿道路拖动到终点处
      移动到此开始验证

      发评论

      以上网友发言只代表其个人观点,不代表新浪网的观点或立场。

      < 前一篇 js 选项卡
      后一篇 > cmd命令
      • 0
        点赞
      • 0
        评论
      • 1
        收藏
      • 一键三连
        一键三连
      • 扫一扫,分享海报

      ©️2021 CSDN 皮肤主题: 编程工作室 设计师:CSDN官方博客 返回首页
      实付
      使用余额支付
      点击重新获取
      扫码支付
      钱包余额 0

      抵扣说明:

      1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
      2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

      余额充值