[实用]AS3的规范,AS3的命名规范--值得收藏
2012-02-06 12:14:25 来源:本站整理一,基本原则
约定大于配置,约定大于规范
规范思想,并非为束缚手脚
在无歧义的前提下,命名力求简洁
在语义明了的前提下,命名力求省力,如果可以同时不按shift,则不按
命名=表义词语+类型,名称表义为先
坚持使用强类型
把常用的成员,放在容易找到的地方,给予它们更大的访问权限
源码格式以清晰易读为准
注释大于代码,代码总是与注释有关的
二,一般规则
文件组织结构与包(在MVCS开发模式下)范式:(companyDomain|teamName).projectName
+controllers 控制器目录
+events 事件目录
+managers 管理器目录
+models 数据模型目录
+models.vos VO对象目录
+services 数据服务目录
+views 视图目录
+views.uis UI目录
+utils 工具类目录
+Module_{Name}.as 模块类(IFacade)
说明:|表示或者,两者取其一
词性:名词
命名:驼峰命名法,第一个单词首字母小写,第二个单词首字母大宇,因形似驼峰而得名
类与类文件范式:SealedName[Type]
说明:若无歧义,[]之内可略去,以下同
如PopUpManager、MouseEvent、StringUtil、FishController等
在MVC开发模式下,如果去掉Type,在项目中则可能出现同名文件,虽然完全限定名不同,但同时在同一个类中被引入时,会给编码带来不便。在这种情况下,保留Type更为合理。
词性:名词
命名:大驼峰命名法(首单词首字母大写)
接口范式:ISealedName[Type]
说明:接口与类相比,不同之处仅在于附有前缀
词性:字母I+名词
命名:大驼峰命名法(首单词首字母大写)
常量范式:CONST_VARIABLE_NAME = “constVariableName”
命名:常量名称单词大宇,间以下划线,常量值使用驼峰命名法
词性:名词、动名词等
用途:在事件类中定义事件类型,在枚举类中定义枚举值等
实例变量、参数变量、函数变量与类静态变量范式:variableName
命名:驼峰命名法
函数范式:[varName_]getMethodName(argName1 :String…)
命名:驼峰命名法
词性:动词、动名词
命名空间范式:lib_internal
命名:小写字母单词,间以下划线
词性:名词+形容词
类成员的位置成员优先级从高到低:常量,静态变量,静态函数,构造器,实例变量,getter/setter属性存取器,函数同级别的成员按访问修饰符排序:public,internal,protected,private
更多精彩
赞助商链接