日期:2013-07-07 浏览次数:20840 次
官方地址:http://opensource.adobe.com/wiki/display/flexsdk/Coding+Conventions
重点翻译:
第一部分
命名
良好的命名是代码易用性和易理解性的关键。你应该花些时间选择合适的命名,特别是对外提供的API。
缩写
避免缩写成为一个规则。全称比缩写好。代码的清晰比命名的精简更重要。不是每个开发者都知道你缩写的含义。
缩写词
在AS3中缩写词很普遍,例如AIR,CSS, URL, XML等。缩写词要么全大写,要么全小写。
词间隔
驼峰式或下划线式
类型指定命名
如果你想把类型合并到命名中,那将这个类型作为最后一个单词追加在命名上。
包名
小写字母开头,普通是名词或动名词,不推荐动词,描述词和副词。
如果一个包里类实现很多类似东西,那么这个包名最好用复数。
文件名
对于重要的API,文件名里最好有地下API在里面。
命名空间
小写字开头,用下划线连接单词
接口
都以I开头
类名
以大写字母开头,以驼峰格式命名。Event的子类FoobarEvent, Error的子类FoorbarError
事件名
以小写开头的驼峰式
常量
全大写,以下划线分割单词
属性(变量)名
小写开头驼峰式, 普通常用i作为循环的索引,n作为上限,j作为内循环索引,m作为它的上限;使用
p(property简写)作为for-in循环的变量;覆盖父类的属性以$开头
私有变量名
如果要实现 getter/setter的私有变量命名为下划线开头,例如 getter/setter foo 变量 _foo
方法名
小写开头驼峰式,方法名应该是动词,覆盖父类的方法以$开头
事件处理函数名
事件处理函数以事件名加”Handle”构成,例如mouseDownHandle()
如果事件是由内部对象发出,那事件处理函数前加事件发送对象,用小划线连接,例如textInput_focusHandle()
参数名
对于setter,参数推荐用value;对于事件推荐使用event(不是e,evt和eventObj)作为参数
尽量避免
“object”由于它含糊不清
“item”是数据元素,不是显示对象
“renderer”是一个提供数据元素的理想对象
“type”是as3的类型,使用”kind”