Extjs4推荐的js编写各种命名规范(译文档)
来源:广州中睿信息技术有限公司官网
发布时间:2012/10/21 23:25:16 编辑:admin 阅读 417
JS命名规范1.类类名之包含字符和数字,数字是允许的但不被鼓励使用,除非它确实需要或者出于技术目的。不要使用下划线,破折线,或者其他非字母和数字的字符。Forexample:MyCompany.us

JS命名规范

1.类 

类名之包含字符和数字,数字是允许的但不被鼓励使用,除非它确实需要或者出于技术目的。 不要使用下划线,破折线,或者其他非字母和数字的字符。

For example:

MyCompany.useful_util.Debug_Toolbar 是不提倡的

MyCompany.util.Base64 is acceptable 是可忍受的

 

类名应当正确和适当地使用"."分组起来,最低限度要有一个顶层的包。

 For example:

MyCompany.data.CoolProxy

MyCompany.Application 

 

只有最上层以及类名应该使用CamelCased,其他的都应该全小写:

 For example:

MyCompany.form.action.AutoLoad 

 

永远也不提倡使用Ext作为你的命名空间。 

 

另外,类名中即便是英文缩写的单词,也必须遵守CamelCased。

 For example:

Ext.data.JsonProxy instead of Ext.data.JSONProxy

MyCompany.util.HtmlParser instead of MyCompary.parser.HTMLParser

MyCompany.server.Http instead of MyCompany.server.HTTP

 

2.源文件

类名应该和JS文件路径互相映射,因此,每个类必须保证单独存放在一个文件中,

For example:

Ext.util.Observable is stored in  path/to/src/Ext/util/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

 

3.方法与变量

与类名类似的,方法和变量名只能包含普通字母和数字,并且数字是允许的但不被鼓励使用,除非它确实需要或者出于技术目的。 不要使用下划线,破折线,或者其他非字母和数字的字符。

方法名和变量名必须保证用camelCased.对于英文缩写同样有效。

Examples

Acceptable method names: encodeUsingMd5() getHtml() instead of getHTML() getJsonResponse() instead of getJSONResponse() parseXmlContent() instead ofparseXMLContent()

Acceptable variable names: var isGoodName var base64Encoder var xmlReader var httpServer

 

4.属性

类的属性命名参照 方法与变量的规则,除了静态成员变量之外。

静态成员变量应当使用全大写模式:

For example:

Ext.MessageBox.YES = "Yes"

Ext.MessageBox.NO = "No"

MyCompany.alien.Math.PI = "4.13"

 

联系我们CONTACT 扫一扫
愿景:成为最专业的软件研发服务领航者
中睿信息技术有限公司 广州•深圳 Tel:020-38931912 务实 Pragmatic
广州:广州市天河区翰景路1号金星大厦18层中睿信息 Fax:020-38931912 专业 Professional
深圳:深圳市福田区车公庙有色金属大厦509~510 Tel:0755-25855012 诚信 Integrity
所有权声明:PMI, PMP, Project Management Professional, PMI-ACP, PMI-PBA和PMBOK是项目管理协会(Project Management Institute, Inc.)的注册标志。
版权所有:广州中睿信息技术有限公司 粤ICP备13082838号-2