当前位置: 首页 > news >正文

AS3编码规范(转)

写AS也有2年之久 一般都是按照ADOBE的写的那份编码规范写,这篇也不错,所以转过来了。

原文地址:http://artlee.biz/572

2010年3月10日 Artlee 版本v1

作者根据自己多年的Flash项目开发及管理经验,吸取驼峰命名法与匈牙利命名法的长处,结合MVCS开发模式,融入面向对象的开发思想,并且考虑到业界已有的不成文的约定,兼顾Flash开发以及Flex开发的便利性,草拟了这份AS3编码经验。请各位大师多多指教。

一,基本原则

  1. 约定大于配置,约定大于规范
  2. 规范思想,并非为束缚手脚
  3. 在无歧义的前提下,命名力求简洁
  4. 在语义明了的前提下,命名力求省力,如果可以同时不按shift,则不按
  5. 命名=表义词语+类型,名称表义为先
  6. 坚持使用强类型
  7. 把常用的成员,放在容易找到的地方,给予它们更大的访问权限
  8. 源码格式以清晰易读为准
  9. 注释大于代码,代码总是与注释有关的

二,一般规则

  1. 文件组织结构与包(在MVCS开发模式下)范式:(companyDomain|teamName).projectName

    +controllers 控制器目录

    +events 事件目录

    +managers 管理器目录

    +models 数据模型目录

    +models.vos VO对象目录

    +services 数据服务目录

    +views 视图目录

    +views.uis UI目录

    +utils 工具类目录

    +Module_{Name}.as 模块类(IFacade)

    说明:|表示或者,两者取其一

    词性:名词

    命名:驼峰命名法,第一个单词首字母小写,第二个单词首字母大宇,因形似驼峰而得名

  2. 类与类文件范式:SealedName[Type]

    说明:若无歧义,[]之内可略去,以下同

    如PopUpManager、MouseEvent、StringUtil、FishController等

    在MVC开发模式下,如果去掉Type,在项目中则可能出现同名文件,虽然完全限定名不同,但同时在同一个类中被引入时,会给编码带来不便。在这种情况下,保留Type更为合理。

    词性:名词

    命名:大驼峰命名法(首单词首字母大写)

  3. 接口范式:ISealedName[Type]

    说明:接口与类相比,不同之处仅在于附有前缀I

    词性:字母I+名词

    命名:大驼峰命名法(首单词首字母大写)

  4. 常量范式:CONST_VARIABLE_NAME = “constVariableName”

    命名:常量名称单词大宇,间以下划线,常量值使用驼峰命名法

    词性:名词、动名词等

    用途:在事件类中定义事件类型,在枚举类中定义枚举值等

  5. 实例变量、参数变量、函数变量与类静态变量范式:variableName

    命名:驼峰命名法

  6. 函数范式:[varName_]getMethodName(argName1 :String…)

    命名:驼峰命名法

    词性:动词、动名词

  7. 命名空间范式:lib_internal

    命名:小写字母单词,间以下划线

    词性:名词+形容词

  8. 类成员的位置成员优先级从高到低:常量,静态变量,静态函数,构造器,实例变量,getter/setter属性存取器,函数

    同级别的成员按访问修饰符排序:public,internal,protected,private

三,具体细则

  1. 在参数变量、函数变量中常用的缩写c : Controller(或ctrl)

    m: Model

    v:View

    e : Event or Error

    mdl: Module

    ui: UI

    srv: Service

    btn:Button

    mc:MovieClip

    spt:Sprite

    n:Num

    j,k,m,n: for循环数字标识

  2. 在MVCS开发模式下,常用的Type后缀视图:View

    视图接口:IView

    控制器:Controller

    数据模型:Model

    数据对象:VO

    UI:UI

    管理器:Manager

    事件集:Events

    事件:Event

    枚举类:*s(在类名加复数s)

    数据服务:Service

    工具类:Util

    模块:Module

    基类:Base

  3. 事件句柄函数命名举例onClick(e :MouseEvent) :void

    btnClose_onClick(e:MouseEvent) :void

    mouseEventHandler(e :MouseEvent) :void

    mcName_mouseEventHandler(e :MouseEvent) :void

  4. 颜色变量使用uint
  5. 时间变量使用Number
  6. switch多在事件句柄函数中使用
  7. 优先使用Vector,在声明数组Array时,标明它的元素类型,如fishs : Array /* Element Of Fish */
  8. 避免使用try..catch
  9. 在for循环中,使用j、k、m、n作为循环数字
  10. 不要声明没有类型的变量,不要使用*使用类型修饰符,避免返回类型为Object的对象
  11. 不用使用Object作为HashMap,使用Dictionary代替
  12. 基本弃用private,默认非公开的实例变量与实例函数使用protected访问修饰符
  13. 在VO类中,默认所有变量使用基元类型作为类型修饰符,使用public作为访问修饰符
  14. 基本弃用getter/setter,在一般情况下,不使用public的getter/setter存取器,代替以public getMethod/setMethod。
  15. 把花括号放在同一列,如:public getMehtod() : void

    {

    }

  16. 在类、函数上使用ASDoc注释,如:/**

    * comment

    */

  17. 不使用下划线作为变量前缀。
  18. 以Flash制作资源文件时:元件成员分层放置,每层须有名称

    库元件分目录放置,以类别组织文件夹

    元件的实例名称使用驼峰命名法,命名规则与实例变量同

    元件的导出名称与所要绑定的类名一致

    Label与AS均单独放在一层里,置于最上面

    避免使用mask

    尽量不要使用滤镜

  19. 控制显示对象的位置时,避免使用小数
  20. 修改fla文件之前要签出、锁定,再修改。
  21. 使用空白字符使代码明晰易读,如:在单词、符号之间使用空格

    在函数、变量之间使用空行

    在包、类、函数、匿名函数各级别间使用缩进

    如果参数列表过长,或数组元素很多,可以拆行,使用相同缩进

  22. 在导入类时,避免使用*号
  23. 约定在注释中添加fixed标签的类或函数,不要随意更改
  24. 函数变量在函数顶部统一声明,在事件函数内部移除事件监听统一放在函数顶部
  25. 在类的顶部写上该类的功能注释,1234,条列清楚,这个类有什么功能均是与此注释有关的。
  26. 不使用for(key:String in Array)的方式迭代数组
  27. 使用[]实例化数组,而非new Array()

转载于:https://www.cnblogs.com/DeasonGuan/archive/2011/12/15/2288781.html

相关文章:

  • 我的Android进阶之旅------ListView中android:cacheColorHint,android:listSelector属性作用 .
  • 技术人员在客户现场工作的注意事项
  • HDU 1520 Anniversary party
  • Android 计时应用 之 爱相随 V0.25
  • 杭电3790--最短路径问题(双权Dijkstra)
  • iostream迭代器的使用(11.18)
  • delphi 图像处理 二值化
  • 6个简单的解决方案解决Internet Explorer中的透明度问题
  • Atom飞行手册翻译: 3.5 创建主题
  • RMAN的基本概念和常用命令
  • 《go语言程序设计》学习(七)
  • Android NDK revision 7 Host 'awk' tool is outda...
  • VLAN的Hybrid和Trunk端口有何区别
  • 运行时库链接错误的修复方法
  • python def和lambda的一点心得
  • (三)从jvm层面了解线程的启动和停止
  • Android 架构优化~MVP 架构改造
  • CentOS学习笔记 - 12. Nginx搭建Centos7.5远程repo
  • Create React App 使用
  • css选择器
  • ES学习笔记(10)--ES6中的函数和数组补漏
  • express.js的介绍及使用
  • js
  • KMP算法及优化
  • macOS 中 shell 创建文件夹及文件并 VS Code 打开
  • nginx 负载服务器优化
  • Ruby 2.x 源代码分析:扩展 概述
  • UEditor初始化失败(实例已存在,但视图未渲染出来,单页化)
  • Vue 重置组件到初始状态
  • vue从入门到进阶:计算属性computed与侦听器watch(三)
  • 回顾2016
  • ------- 计算机网络基础
  • 浅谈JavaScript的面向对象和它的封装、继承、多态
  • 适配iPhoneX、iPhoneXs、iPhoneXs Max、iPhoneXr 屏幕尺寸及安全区域
  • 移动端 h5开发相关内容总结(三)
  • 栈实现走出迷宫(C++)
  • 主流的CSS水平和垂直居中技术大全
  • 阿里云ACE认证学习知识点梳理
  • 我们雇佣了一只大猴子...
  • ​HTTP与HTTPS:网络通信的安全卫士
  • ​七周四次课(5月9日)iptables filter表案例、iptables nat表应用
  • #define与typedef区别
  • #includecmath
  • #Linux杂记--将Python3的源码编译为.so文件方法与Linux环境下的交叉编译方法
  • (1)Nginx简介和安装教程
  • (2)Java 简介
  • (22)C#传智:复习,多态虚方法抽象类接口,静态类,String与StringBuilder,集合泛型List与Dictionary,文件类,结构与类的区别
  • (亲测成功)在centos7.5上安装kvm,通过VNC远程连接并创建多台ubuntu虚拟机(ubuntu server版本)...
  • (原創) 如何解决make kernel时『clock skew detected』的warning? (OS) (Linux)
  • **登录+JWT+异常处理+拦截器+ThreadLocal-开发思想与代码实现**
  • .gitignore
  • .net CHARTING图表控件下载地址
  • .net framwork4.6操作MySQL报错Character set ‘utf8mb3‘ is not supported 解决方法
  • .NET gRPC 和RESTful简单对比
  • .NET MVC第三章、三种传值方式