关闭

ExtJS学习笔记二:编码规范

标签: extjs规范
294人阅读 评论(0) 收藏 举报
分类:

编码规范

在所有类、命名空间(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”
0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:12718次
    • 积分:211
    • 等级:
    • 排名:千里之外
    • 原创:5篇
    • 转载:9篇
    • 译文:0篇
    • 评论:0条
    文章分类