AS3编码规范.doc

一，基本原则约定大于配置，约定大于规范规范思想，并非为束缚手脚在无歧义的前提下，命名力求简洁在语义明了的前提下，命名力求省力，如果可以同时不按shift，则不按命名表义词语类型，名称表义为先坚持使用强类型把常用的成员，放在容易找到的地方，给予它们更大的访问权限二，一般规则文件组织结构与包(在MVCS开发模式下)范式：(companyDomain|teamName).projectNameconsts 常量目录controllers 控制器目录events事件目录managers 管理器目录models数据模型目录models.vos VO对象目录services 数据服务目录views 视图目录views.uis UI目录utils 工具类目录Module_Name.as 模块类(IFacade)说明：|表示或者，两者取其一词性：名词命名：驼峰命名法，第一个单词首字母小写，第二个单词首字母大宇，因形似驼峰而得名类与类文件范式：SealedNameType说明：若无歧义，之内可略去，以下同如PopUpManager、MouseEvent、StringUtil、FishController等在MVC开发模式下，如果去掉Type，在项目中则可能出现同名文件，虽然完全限定名不同，但同时在同一个类中被引入时，会给编码带来不便。在这种情况下，保留Type更为合理。词性：名词命名：大驼峰命名法（首单词首字母大写）接口范式：ISealedNameType说明：接口与类相比，不同之处仅在于附有前缀I词性：字母I名词命名：大驼峰命名法（首单词首字母大写）常量范式：CONST_VARIABLE_NAME “constVariableName”命名：常量名称单词大宇，间以下划线，常量值使用驼峰命名法词性：名词、动名词等用途：在事件类中定义事件类型，在枚举类中定义枚举值等实例变量、参数变量、函数变量与类静态变量范式：variableName命名：驼峰命名法函数范式：varName_getMethodName(argName1 :String)命名：驼峰命名法词性：动词、动名词命名空间范式：lib_internal命名：小写字母单词，间以下划线词性：名词形容词类成员的位置成员优先级从高到低：常量，静态变量，静态函数，构造器，实例变量，getter/setter属性存取器，函数同级别的成员按访问修饰符排序：public，internal，protected，private三，具体细则在参数变量、函数变量中常用的缩写c : Controller（或ctrl）m: Modelv：Viewe : Event or Errormdl: Moduleui: UIsrv: Servicebtn:Buttonmc:MovieClipspt:Sprite在MVCS开发模式下，常用的Type后缀视图：View视图接口：IView控制器：Controller数据模型：Model数据对象：VOUI：UI管理器：Manager事件集：Events事件：Event常量：s数据服务：Service工具类：Util模块：Module事件句柄函数命名举例onClick(e :MouseEvent) :voidbtnClose_onClick(e:MouseEvent) :voidmouseEventHandler(e :MouseEvent) :voidmcName_mouseEventHandler(e :MouseEvent) :void颜色变量使用uint时间变量使用Numberswitch多在事件句柄函数中使用优先使用Vector，在声明数组Array时，标明它的元素类型，如fishs : Array /* Element Of Fish */避免使用try.catch在for循环中，使用j、k、m、n作为循环数字不要声明没有类型的变量，不要使用使用类型修饰符，避免返回类型为Object的对象不用使用Object作为HashMap，使用Dictionary代替基本弃用private，默认非公开的实例变量与实例函数使用protected访问修饰符在VO类中，默认所有变量使用基元类型作为类型修饰符，使用public作为访问修饰符基本弃用getter/setter，在一般情况下，不使用public的getter/setter存取器，代替以public getMethod/setMethod。把花括号放在同一列，如：public getMehtod() : void在类、函数上使用ASDoc注释，如：/* comment*/擅用空行于函数与函数之间，变量与函数之间等，擅用空格于词语之间，如：for (var j:int=0; j10; j+)不使用下划线作为变量前缀。以Flash制作资源文件时：元件成员分层放置，每层须有名称库元件分目录放置，以类别组织文件夹元件的实例名称使用驼