Javascript 编程规范

2016-02-20 00:36 2 1 收藏

图老师设计创意栏目是一个分享最好最实用的教程的社区,我们拥有最用心的各种教程,今天就给大家分享Javascript 编程规范的教程,热爱PS的朋友们快点看过来吧!

【 tulaoshi.com - Web开发 】

前言

相当不错的 Javascript 编程风格规范,建议大家采用此规范编写 Javascript。原文链接: http://dojotoolkit.org/developer/StyleGuide 。

翻译(Translated by):feelinglucky{at}gmail.com,转载请注明出处、作者和翻译者,谢谢配合。

本文地址: http://code.google.com/p/grace/wiki/DojoStyle 。

(本文来源于图老师网站,更多请访问http://www.tulaoshi.com/webkaifa/)

Any violation to this guide is allowed if it enhances readability.

所有的代码都要变成可供他人容易阅读的。

快读参考

(本文来源于图老师网站,更多请访问http://www.tulaoshi.com/webkaifa/)

核心 API 请使用下面的风格:

结构 规则 注释

下面的虽然不是必要的,但建议使用:

结构 规则混合,例子: 混合,例子: 混合,例子: 混合,例子:

命名规范

变量名称 必须为 小写字母。 类的命名使用骆驼命名规则,例如:
Account, EventHandler 常量 必须 在对象(类)或者枚举变量的前部声明。枚举变量的命名必须要有实际的意义,并且其成员 必须 使用骆驼命名规则或使用大写:
var NodeTypes = {
    Element : 1,
    DOCUMENT: 2
} 简写单词 不能使用 大写名称作为变量名:
getInnerHtml(), getXml(), XmlDocument 方法的命令 必须 为动词或者是动词短语:
obj.getSomeValue() 公有类的命名 必须 使用混合名称(mixedCase)命名。 CSS 变量的命名 必须 使用其对应的相同的公共类变量。 私有类的变量属性成员 必须 使用混合名称(mixedCase)命名,并前面下下划线(_)。例如:
var MyClass = function(){
   var _buffer;
   this.doSomething = function(){
   };
} 变量如果设置为私有,则前面 必须 添加下划线。
this._somePrivateVariable = statement; 通用的变量 必须 使用与其名字一致的类型名称:
setTopic(topic) // 变量 topic 为 Topic 类型的变量 所有的变量名 必须 使用英文名称。 变量如有较广的作用域(large scope),必须使用全局变量;此时可以设计成一个类的成员。相对的如作用域较小或为私有变量则使用简洁的单词命名。 如果变量有其隐含的返回值,则避免使用其相似的方法:
getHandler(); // 避免使用 getEventHandler() 公有变量必须清楚的表达其自身的属性,避免字义含糊不清,例如:
MouseEventHandler,而非 MseEvtHdlr
请再次注意这条规定,这样做得的好处是非常明显的。它能明确的表达表达式所定义的含义。例如:
dojo.events.mouse.Handler // 而非 dojo.events.mouse.MouseEventHandler 类/构造函数 可以使用 扩展其基类的名称命名,这样可以正确、迅速的找到其基类的名称:
EventHandler
UIEventHandler
MouseEventHandler
基类可以在明确描述其属性的前提下,缩减其命名:
MouseEventHandler as opposed to MouseUIEventHandler.

来源:http://www.tulaoshi.com/n/20160220/1632198.html

延伸阅读
标签: Web开发
简介 你是否知道JavaScript其实也是一个函数式编程语言呢?本指南将教你如何利用JavaScript的函数式特性。  要求:你应当已经对JavaScript和DOM有了一个基本的了解。 写这篇指南的目的是因为关于JavaScript编程的资料太多了但是极少的资料提到了JavaScript的函数式特性。在本指南中,我只会讲解这些基本知识而不会深入其它的函数式语...
标签: Web开发
牢记:函数式编程不是用函数来编程!!! 23.4函数式编程 23.4.1 什么是函数式编程 什么是函数式编程?如果你这么直白地询问,会发现它竟是一个不太容易解释的概念。许多在程序设计领域有着多年经验的老手,也无法很明白地说清楚函数式编程到底在研究些什么。函数式编程对于熟悉过程式程序设计的程序员来说的确是一个陌生的领域,闭包(cl...
    在写面向对象的WEB应用程序方面JavaSciprt是一种很好的选择.它能支持OOP.因为它通过原型支持继承的方式和通过属性和方法的方式一样好.很多开发者试图抛弃JS,试着用C#或JAVA仅是因为JS不是他认为合适的面向对象的语言.许多人还没有认识到javascript支持继承.当你写面向对象的代码时.它能给你很强大的能量.你也可以使用它写出...
标签: Web开发
作者:月影 牢记:函数式编程不是用函数来编程!!! 23.4函数式编程  23.4.1 什么是函数式编程         什么是函数式编程?如果你这么直白地询问,会发现它竟是一个不太容易解释的概念。许多在程序设计领域有着多年经验的老手,也无法很明白地说清楚函数式编程到底在研究些什么。函数式...
标签: Web开发
关于对象化编程的语句 现在我们有实力学习以下关于对象化编程,但其实属于上一章的内容了。 with 语句 为一个或一组语句指定默认对象。 用法: with (对象) 语句; with 语句通常用来缩短特定情形下必须写的代码量。在下面的例子中,请注意 Math 的重复使用: x = Math.cos(3 *&...

经验教程

372

收藏

22
微博分享 QQ分享 QQ空间 手机页面 收藏网站 回到头部