写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

AS3编码规范(转)相关推荐

  1. JavaScript最全编码规范

    转载: JavaScript最全编码规范 类型 ●基本类型:访问基本类型时,应该直接操作类型值 ●string ●number ●boolean ●null ●undefined var foo = ...

  2. 【C++】Google C++编码规范(三):智能指针

    [C++]Google C++编码规范(一):作用域 [C++]Google C++编码规范(二):类 std::unique_ptr std::unique_ptr是C++11标准里新推出的智能指针 ...

  3. 《阿里巴巴编码规范(JAVA)》学习认证考后感

    image.png <阿里巴巴 Java 开发手册>是阿里巴巴集团技术团队的集体智慧结晶和经验总结,经历了多次大规模一线实战的检验及不断完善,系统化地整理成册,回馈给广大开发者. 本手册的 ...

  4. google python代码规范_如何用好python编码规范,写一手漂亮的代码

    前一段时间在编写python 代码的时候编辑器中一直在提示规范问题,因为强迫症的原因,我决定遵循python 的编码规范去编码,然后把需要注意的点记录下来, 帮助自己和大家一起成长. 这是我的main ...

  5. Python最简编码规范

    0.前言 本文是阅读<Python Coding Rule>之后总结的最为精华及简单的编码规范,根据每个人不同喜好有些地方会有不同的选择,我只是做了对自己来说最简单易行的选择,仅供大家参考 ...

  6. 华为java安全编码规范_Java安全编码之SQL注入

    随着互联网的发展,Java语言在金融服务业.电子商务.大数据技术等方面的应用极其广泛.Java安全编码规范早已成为SDL中不可或缺的一部分.本文以Java项目广泛采用的两个框架Hibernate和My ...

  7. 分享GitHub上一位老外的嵌入式C编码规范(收藏细读)

    简 介: 本文分析在头条上分享GitHub上一位老外的嵌入式C编码规范(收藏细读):嵌入式大杂烩. 关键词: 嵌入式,C语句,编程规范 分享GitHub上一位老外的嵌入式C编码规范(收藏细读) §01 ...

  8. PHP标记风格,编码规范

    PHP标记风格 PHP一共支持4种标记风格 <?php echo "这是XML风格的标记"; ?> 脚本风格 <script language="php ...

  9. Go 语言编程 — 编码规范指南

    目录 文章目录 目录 参考 工程化要求 编码规范 大小约定 缩进.括号和空格约定 命名规范 包.目录命名规范 文件命名规范 标识符命名规范 变量.常量名 函数.方法名 结构体.接口名 空行.注释.文档 ...

最新文章

  1. wcf 返回图片_WCF实现上传图片功能
  2. python3 获取当前路径_如何使用python3获取当前路径及os.path.dirname的使用
  3. python【数据结构与算法】红黑树概念辨析
  4. fegin需要实现类_深入理解JVM(六)--虚拟机类加载机制
  5. JMS(Java消息服务)入门教程
  6. leetcode 543. 二叉树的直径(Java版)
  7. java字符流和字节流的区别_java字符流与字节流的区别是什么
  8. 茜在人名可以读xi吗_甘肃中专学校:初中毕业可以读大专吗?
  9. JavaSE基础chapter1Homework
  10. Debian Linux下的Python学习——入门
  11. python word处理_Python 处理word期间遇到的问题
  12. 【计算机网络】计算机网络基础知识笔记
  13. 【数学建模】Python+Gurobi求解线性规划
  14. web端的shader Threejs飞线
  15. 2023年3月份隐私计算市场洞察
  16. Angular primeng tree 组件数据解析(适用于Angular2+)
  17. [31期]上班这点事
  18. Beyond Compare 相同文件对比结果仍显示红色 解决方案【转存】
  19. 后台核心编程(二):调试工具
  20. 史玉柱深度剖析:民营的13种“死法”

热门文章

  1. php checkbox 保存,PHP中在数据库中保存Checkbox数据
  2. lftp linux,linux下使用 lftp
  3. C++ struct和class的区别
  4. 互联网晚报 | 3月1日 星期二 |​ 2022年苹果可能推出三款Apple Watch;“国家中小学智慧教育平台”投入试运行...
  5. NEW WAVE年轻人品质旅游报告
  6. python 加锁_Python 共享变量加锁、释放详解
  7. html左滑效果图,前端福利——左滑右滑,绝对是你见过的最简单的写法 - 你猜猜看...
  8. 【软件工程】软件复用
  9. 深入理解 操作系统 SJF算法(以洛谷P1223题为例)
  10. 【VBS】IE11如何运行 Visual Basic Script 程序