JavaScript 编程规范入门详解(1/3)

命名规范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.变量如有较广的作用域(large scope),必须使用全局变量;此时可以设计成一个类的成员。相对的如作用域较小或为私有变量则使用简洁的单词命名。
13.如果变量有其隐含的返回值,则避免使用其相似的方法:

getHandler(); // 避免使用 getEventHandler()
14.公有变量必须清楚的表达其自身的属性,避免字义含糊不清,例如:

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

dojo.events.mouse.Handler // 而非 dojo.events.mouse.MouseEventHandler
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 be used 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”。
方法如果返回一个类,则应该在名称上说明返回什么;如果是一个过程,则应该说明做了什么。
文件缩进请使用 4 个空白符的制表位。
如果您的编辑器支持 文件标签_(file tags),请加添如下的一行使我们的代码更容易阅读:

// vim:ts=4:noet:tw=0:
译注:老外用 VIM 编辑器比较多,此条可以选择遵循。

首页 1 2 3 末页

时间: 2024-10-14 23:10:17

JavaScript 编程规范入门详解(1/3)的相关文章

比较全面的C 、Java、JavaScript中的正则表达式详解_正则表达式

什么是正则表达式? 正则表达式(Regular Expression) 就是用某种模式去匹配一类字符串的公式.如你要在一篇文章中查找第一个字是"罗"最后一个字是"浩"的三个字的姓名,即"罗 * 浩":那么"罗 * 浩"就是公式,也称作 模式(Pattern) ,这篇文章就是 要匹配的串( 或叫文本 text) .再如,你要检查输入的一个字符串是否是 126 邮箱的格式,你得制定一个规则去查检,这种规则就是正则表达式. 从入门开

gitbook入门详解

gitbook入门详解 在ata上面看了几篇关于gitbook的文章,感觉都是适合之前已经了解过gitbook的同学来学习的,是跳跃式的,说得比较简略,省略了中间的一部分步骤,这并不适合零基础的新人,于是下面向新人详细介绍gitbook. 说到gitbook,很容易联想到git和github,那么它们究竟有什么关系呢? 其实就是java跟javascript的关系,或是雷锋跟雷锋塔的关系,也就是并没有什么关系... gitbook 是一个基于 Node.js 的命令行工具,使用 markdown

JavaScript数组和循环详解

          JavaScript数组和循环详解           这篇文章主要介绍了JavaScript数组和循环详解,本文讲解了循环遍历数组.按顺序存储和访问值.以相反的顺序存储和访问值.在数组中搜索等内容,需要的朋友可以参考下               数组是元素的一个有序组合.在JavaScript中,数组可以使用正式的对象表示法来创建,或者可以使用直接量表示法来初始化.   代码如下: var arrObject = new Array("val1", "

Quartz 入门详解 专题

Cron-Expressions are used to configure instances of CronTrigger. Cron-Expressions are strings that are actually made up of seven sub-expressions, that describe individual details of the schedule. These sub-expression are separated with white-space, a

JavaScript数据结构链表知识详解_javascript技巧

最近在看<javascript数据结构和算法>这本书,补一下数据结构和算法部分的知识,觉得自己这块是短板. 链表:存储有序的元素集合,但不同于数组,链表中的元素在内存中不是连续放置的.每个元素由一个存储元素本身的节点和一个指向下一个元素的引用(也称指针或链接)组成. 好处:可以添加或移除任意项,它会按需扩容,且不需要移动其他元素. 与数组的区别:     数组:可以直接访问任何位置的任何元素:     链表:想要访问链表中的一个元素,需要从起点(表头)开始迭代列表直到找到所需的元素. 做点小笔

JqueryUIdialog基础入门详解(中文)

JqueryUIdialog基础入门详解(中文) 1 属性   1.11 autoOpen ,这个属性为true的时候dialog被调用的时候自动打开dialog窗口.当属性为false的时候,一开始隐藏窗口,知道.dialog("open")的时候才弹出dialog窗口.默认为:true.   1.12 初始化例:请注意,$(''.selector'')是dialog 的类名,在本例中.selector=#dialoag,以后不再说明.   $(''.selector'').dial

JavaScript Event Loop机制详解与Vue.js中nextTick的实践应用

本文依次介绍了函数调用栈.MacroTask 与 MicroTask 执行顺序.浅析 Vue.js 中 nextTick 实现等内容;本文中引用的参考资料统一声明在 JavaScript 学习与实践资料索引. 1. 事件循环机制详解与实践应用 JavaScript 是典型的单线程单并发语言,即表示在同一时间片内其只能执行单个任务或者部分代码片.换言之,我们可以认为某个同域浏览器上下中 JavaScript 主线程拥有一个函数调用栈以及一个任务队列(参考 whatwg 规范);主线程会依次执行代码

Javascript中this关键字详解

Quiz 请看下面的代码,最后alert出来的是什么呢? 1 var name = "Bob"; 2 var nameObj ={ 3 name : "Tom", 4 showName : function(){ 5 alert(this.name); 6 }, 7 waitShowName : function(){ 8 setTimeout(this.showName, 1000); 9 } 10 }; 11 12 nameObj.waitShowName();

javascript中this指向详解_基础知识

JavaScript 是一种脚本语言,支持函数式编程.闭包.基于原型的继承等高级功能.JavaScript一开始看起来感觉会很容易入门,但是随着使用的深入,你会发JavaScript其实很难掌握,有些基本概念让人匪夷所思.其中JavaScript 中的 this 关键字,就是一个比较容易混乱的概念,在不同的场景下,this会化身不同的对象.有一种观点认为,只有正确掌握了 JavaScript 中的 this 关键字,才算是迈入了 JavaScript 这门语言的门槛.在主流的面向对象的语言中(例