Javascript 编程规范

微企融

微企融

2016-02-20 00:36

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

前言

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

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

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

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

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

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

(本文来源于图老师网站,更多请访问http://m.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.

展开更多 50%)
分享

猜你喜欢

Javascript 编程规范

Web开发
Javascript 编程规范

JavaScript编程语言的编码规范

Web开发
JavaScript编程语言的编码规范

s8lol主宰符文怎么配

英雄联盟 网络游戏
s8lol主宰符文怎么配

浅谈JavaScript编程语言的编码规范

电脑网络
浅谈JavaScript编程语言的编码规范

.NET编程规范

电脑网络
.NET编程规范

lol偷钱流符文搭配推荐

英雄联盟 网络游戏
lol偷钱流符文搭配推荐

JAVA编程规范

编程语言 网络编程
JAVA编程规范

PHP 编码规范-编程惯例

PHP
PHP 编码规范-编程惯例

lolAD刺客新符文搭配推荐

英雄联盟
lolAD刺客新符文搭配推荐

年轮流转的QQ分组设计时光飞逝我们彼此遗忘着

年轮流转的QQ分组设计时光飞逝我们彼此遗忘着

AJAX无刷新更新数据

AJAX无刷新更新数据
下拉加载更多内容 ↓