jQuery MiniUI,快速开发WebUI界面

Sencha Touch命名规范


类名

类名只包含字母和数字,但在多数情况下不鼓励使用数字,除非是技术术语,不要使用下划线,连字符,和其他非数字字母的字符,例如:

  • MyCompany.useful_util.Debug_Toolbar is discouraged
  • MyCompany.util.Base64 is acceptable

类名应当分组成包,适当时,使用.进行命名空间划分,至少在类名中应该有一个唯一的命令空间。例如:

MyCompany.data.CoolProxy
MyCompany.Application

顶层的命名空间和具体的类名采用驼峰式命名,其他的均使用小写字母

MyCompany.form.action.AutoLoad

不是Sencha分发的类不可使用Ext作为顶层的命名空间。 首字母缩写词,也应该遵循驼峰约定,例如:

  • Ext.data.JsonProxy instead of Ext.data.JSONProxy
  • MyCompany.util.HtmlParser instead of MyCompary.parser.HTMLParser
  • MyCompany.server.Http instead of MyCompany.server.HTTP

源文件

源文件的类名直接映射到文件的存储路径,同时在一个文件中只能含有一个类,如下:

  • Ext.mixin.Observable is stored in path/to/src/Ext/mixin/Observable.js
  • Ext.form.action.Submit is stored in path/to/src/Ext/form/action/Submit.js
  • MyCompany.chart.axis.Numeric is stored in path/to/src/MyCompany/chart/axis/Numeric.js

_path/to/src_是应用的类目录,所有的类都在该目录下,同时按照部署,维护和经验进行命名空间划分。

方法和变量

与类名的命名规则相同。 命名采用驼峰方式,包括首字母缩写词。

举例:

正确的方法命名:

encodeUsingMd5()
getHtml() instead of getHTML()
getJsonResponse() instead of getJSONResponse()
parseXmlContent() instead of parseXMLContent()

正确的变量命名:

var isGoodName
var base64Encoder
var xmlReader
var httpServer

属性

属性的命名规则与方法和变量命名规则类似,但静态常量除外,静态常量采用全大写的方式,如下:

Ext.MessageBox.YES = "Yes"
Ext.MessageBox.NO = "No"
MyCompany.alien.Math.PI = "4.13"

作者: Deju.tu
原文: http://www.afewords.com/blog/5111c53f37251774ce3bea3c