ExtJS 命名规约
ExtJS本质依然是一个JavaScript框架,所以要遵循JavaScript的命名规约。Sencha推荐使用以下的命名方式(原文地址),关于命名的更多信息,参考这个javascript.crockford.com:
对象 | 规约 | 例子 |
---|---|---|
类名 (Class) | 大驼峰(CamelCase)原则。 | MyCustomClass |
类名应该只含有字母数字。专业术语中也可是数字。 | Base64 | |
不要使用下划线、连字符之类的特殊字符。 | ||
类名应该至少包含一个由(.)分隔的命名空间。 | TopLevelNamespace.MyClassName | |
顶级命名空间和当前类名都应该遵循大驼峰(CamelCase)原则,其余的都应该是小写(例如:middnamespace)。 | TopNamespace.middnamespace.CustomClass | |
源文件 (Source File) | 类名和文件路径应该一一对应。 | 类名 Ext.util.Observable 对应 path/to/src/Ext/util/Observable.js 类名 MyTopLevelNamespace.util.JsonToXml 对应 path/to/src/MyTopLevelNamespace/util/JsonToXml.js |
方法 (Methods) | 小驼峰(camelCase)原则。 | encodeUsingMd5(), getHtml() |
变量 (Variables) | 小驼峰(camelCase)原则。 | var isGoodName var base64Encoder |
常量(Constant variable)一概大写。 | var SALARY = 1000 | |
私有变量(Private variable)以下划线打头。 | var _privateVariable | |
属性 (Properties) | 小驼峰(camelCase)原则。静态属性(Static properties)一律大写。 | Ext.MessageBox.YES = “Yes” |