ExtJS学习笔记二:编码规范

转载 2015年07月09日 15:02:08

编码规范

在所有类、命名空间(namespace)和文件名中使用一致的命名约定,有助于保持代码的良好结构和可读性。

1、类名

类名只能包含字母和数字。允许包含数字,但是大部分情况下不建议使用,除非这些数字是专业术语的一部分。不要使用下划线,连字符等非数字字母符号。例如:
错误案例:MyCompany.useful_util.Debug_Toolbar is discouraged
正确案例:MyCompany.util.Base64 is acceptable

类名应该包含在使用点号分隔的命名空间中。至少,要有一个顶级命名空间。例如:
MyCompany.data.CoolProxyMyCompany.Application

顶级命名空间和实际的类名应使用驼峰命名(CamelCased),其他则为小写。例如:
MyCompany.form.action.AutoLoad

不是Sencha开发的类(即不是Ext自带的)不要使用Ext做为顶级命名空间。缩写也要遵守以上的驼峰式命名约定。

2、代码文件名

代码文件类名对应类所在的文件(包括文件名)。因此,每个文件应该只包含一个类(类名和文件名一样)。例如:
Ext.util.Observable 存放在 path/to/src/Ext/util/Observable.js
MyCompany.chart.axis.Numeric 存放在 path/to/src/MyCompany/chart/axis/Numeric.js

path/to/src 是你的应用所在目录。所有类都应该在这个通用根目录下,并且使用适当的命名空间以利于开发、维护和部署。

3、方法名与变量名

  • 和类命名一样,方法和变量也只能包含字母和数字。数字同样是允许但不建议,除非属于专业术语。不要使用下划线,连字符等任何非字母数字符号。
  • 方法和变量名一样使用驼峰式命名,缩写也一样。
    方法名例如:
    getJsonResponse() 代替 getJSONResponse()
    parseXmlContent() 代替parseXMLContent()
    变量名例如:
    var isGoodName
    var base64Encoder

4、属性

  • 类属性名称遵循以上的变量和方法命名约定
  • 类的静态属性常量应该全部大写。例如:
    Ext.MessageBox.YES = “Yes”
    MyCompany.alien.Math.PI = “4.13”

ExtJS学习笔记(二) Grid

var grid = null;// 数据源 var store = Ext.create("Ext.data.Store", { pageSize: 10, fields: [ ...

ExtJS4学习笔记二--表单控件相关

二、表单部分相关  Html代码   HTML>    HEAD>     TITLE>提示信息TITLE>     meta http-equiv="Content...

ExtJS 4.2.1学习笔记(二)——主题theme

1                 UI组件基础 学习ExtJs就是学习组件的使用。ExtJs4对框架进行了重构,其中最重要的就是形成了一个结构及层次分明的组件体系,由这些组件形成了Ext的控件...
  • dahuzix
  • dahuzix
  • 2014年04月27日 16:18
  • 488

ExtJS4学习笔记二--表单控件相关

二、表单部分相关  Html代码   HTML>    HEAD>     TITLE>提示信息TITLE>     meta http-equiv="Content...

extjs4学习笔记(二)----- 监听事件beforeload使用

EXTJS 4
  • yfcaone
  • yfcaone
  • 2017年03月15日 22:09
  • 1651

ExtJS4学习笔记(二)---HBox的使用

要使用HBox布局方式,首先的熟悉下一下几个主要属性: 一、align:字符类型,指示组件在容器内的对齐方式。有如下几种属性。     1、top(默认):排列于容器顶端。     2、midd...

EXTJS学习笔记

  • 2014年05月19日 21:39
  • 1.04MB
  • 下载

ExtJs学习笔记.pdf

  • 2011年07月06日 15:54
  • 870KB
  • 下载

【学习笔记】JavaScript编码规范- 注释

多行注释使用/**……*/,需要包含一个描述,所有参数的具体类型的值还有返回值。 // bad // make() returns a new element // based on the pass...

EXTJS学习笔记

  • 2012年05月15日 14:57
  • 1.04MB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:ExtJS学习笔记二:编码规范
举报原因:
原因补充:

(最多只允许输入30个字)