Sencha Touch规范

Sencha Touch是一个很棒的前端框架,在2014年年底被公司应用到掌上高考APP的开发当中。她提供了很多漂亮的移动UI组件和高性能的页面渲染模式,基于Ext的语法又让这个框架非常稳定和成熟,方便扩展插件,文档齐全。

初始化项目

前提条件:
1、安装最新版本的Sencha Cmd 6
2、Java 运行时环境 (JRE)
安装可以参考网站:http://www.jeeboot.com/archives/1211.html

用Sencha Cmd生成第一个Ext JS应用

打开命令行键入一下内容

sencha generate app --ext MyApp ./myapp

运行上面的命令将会创建名为 MyApp 的 Ext JS 应用,应用所有的文件都放在当前目录下名为 myapp 的文件夹。

命名约定

类名只能包含字母和数字。允许包含数字,但是大部分情况下不建议使用,除非这些数字是专业术语的一部分。不要使用下划线,连字符等非数字字母符号。例如:

MyCompany.useful_util.Debug_Toolbar 不建议
MyCompany.util.Base64 合适的(虽然包含数字,但是数字是术语的一部分)

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

MyCompany.data.CoolProxyMyComp
MyCompany.data.CoolProxyMyCompa

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

MyCompany.form.action.AutoLoad

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

Ext.data.JsonProxy而不是Ext.data.JSONProxy
MyCompany.util.HtmlParser而不是MyCompary.parser.HTMLParser
MyCompany.server.Http而不是MyCompany.server.HTTP

代码文件

类名对应类所在的文件(包括文件名)。因此,每个文件应该只包含一个类(类名和文件名一样)。例如:

Ext.util.Observable 存储在 path/to/src/Ext/util/Observable.js
Ext.form.action.Submit 存储在 path/to/src/Ext/form/action/Submit.js
MyCompany.chart.axis.Numeric 存储在 path/to/src/MyCompany/chart/axis/Numeric.js

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

方法和变量

和类命名一样,方法和变量也只能包含字母和数字。数字同样是允许但不建议,除非属于专业术语。不要使用下划线,连字符等任何非字母数字符号。
方法和变量名一样使用驼峰式命名,缩写也一样。
举例
合适的方法名:

encodeUsingMd5() getHtml() 代替 getHTML()
getJsonResponse() 代替 getJSONResponse()
parseXmlContent() 代替 parseXMLContent()

合适的变量名:

var isGoodName
var base64Encoder
var xmlReader
var httpServer