loading ...
loading...

2008-07-18 | Adobe官方推荐的ActionScript的最佳做法和编码约定

分享
一.命名约定

1将命名约定用于变量名称可提供下列重要功能:

-这些约定使代码易于阅读,以便您可以立即识别出变量的数据类型。这样做可以帮助学生(学习代码的人)和不熟悉您的代码的开发人员。

-必要时便于搜索和替换。
-有助于减少保留字和语言构造之间的冲突。
-有助于区分不同作用范围的变量(局部变量、类属性、参数等等)。


2常规命名准则

-限制使用缩写词。使用一致的缩写词。缩写词必须清楚地仅表示一种含义。
-连接单词以创建名称。在连接单词时请使用混合大小写以便区分每个单词,增强可读性。
-按描述过程或描述项的方式命名文件,如 addUser。
-不要为方法或变量使用非描述性的名称。
-尽可能保持所有名称最短。


3避免使用保留字和语言构造

-永远不要使用不同的大小写来避免与保留字发生冲突。例如,将 TextField 类的一个实例命名为 textfield(它不会与 TextField 发生冲突,因为 Flash 是区分大小写的)就是一种欠佳的编码做法。


4命名变量

-尽可能对变量使用严格数据类型指定
-所有变量名称必须是唯一的。
-不要使用大小写不同的相同变量名称。
-不要将 ActionScript 1.0 或 2.0 中的部分字用作变量名称。
-不要使用作为公共编程构造组成部分的变量。  eg:switch = true;

-始终在代码中添加数据类型注释。
-不要过多使用 Object 类型。
-在保持意义明确的同时尽可能地保持变量简短。
-为了在循环中起到优化作用,请只使用单字符变量名称。
-变量以小写字母开头。
-对于相连接的词使用混合大小写。
-不要使用首字母缩写词和缩写词。
-在创建一组相关的变量名称时,应使用互补对。


5命名常数

-常数应为大写字母。
-分隔单词应包含下划线。


6命名布尔变量

-布尔变量应以字"is"开头(因为布尔值本质上只有"is"或"is not"两个值)。


7命名函数和方法
-使用具有描述性的名称
-对于相连接的词使用混合大小写。
-函数和方法的名称以小写字母开头
-在函数名称中描述要返回的值。
-为相关的类似函数建立命名标准。
-将方法命名为动词。可能连接名称,但名称中应当包含动词。大多数方法都用动词来表示,因为方法对对象执行操作。


8命名类和对象

-类名称以大写字母开头。
-当类名称为组合词或相连接的词时,用混合大小写编写类名称。
-类名称通常为名词或限定名词。
-名称的含义清楚比名称简短更为重要。
-不要使用首字母缩写词和缩写词。
-使用对类内容具有描述性意义的简短名称。
-有时类名称会是一个组合词。
-在类名称中不要使用复数形式的字(如 Witches 或 BaldPirates)。
-不要在类的属性中使用类名称,因为这会过于冗长。
-不要使用可以解释为动词的名词。
-在一个应用程序中为每个类使用唯一的类名称。
-不要给类命名,因为可能会与 Flash 中内置类的名称发生冲突。
-尝试表明类在层次中的关系。


9命名包

-使用"反向域"命名约定命名包是很常见的。例如,用 com.adobe 命名 adobe.com,用 org.yourdomain 命名 yourdomain.org 即为反向域名称的示例。

-包名称的前缀全部使用小写字母。
-将相关的类(具有相关功能的类)放入相同的包中。
-包名称以一致的前缀开头。
-使用意义清晰并且具有自我说明性质的包名称。

-为组合包名称或相连接的包名称使用混合大小写。
-不要使用下划线或美元符号字符


10命名接口

-接口名称以大写字母"I"开头可帮助您将接口和类区分开。接口名称 IEmployeeRecords 使用大写的首字母和混合大小写的连接字
eg:
interface IEmployeeRecords{}

-接口名称的首字母要大写。
-此约定与类名称约定相同。
-接口名称通常为形容词。eg rintable


11命名自定义组件

-组件名称的第一个字母为大写,并且任何相连接的字都是以混合大小写来书写。

eg:下面的默认用户接口组件设置均使用相连接的单词和混合大小写:
CheckBox
ComboBox
DataGrid
DateChooser
DateField
MenuBar
NumericStepper
ProgressBar
RadioButton
ScrollPane
TextArea
TextInput

-不使用相连接的字的组件以大写字母开头。



二.在代码中使用注释

1编写好的注释

-多行注释使用块注释 (/* 和 */),而简短的注释则使用单行注释 ( // )。
-确保不要使用注释对 ActionScript 代码进行简单翻译。
-对代码中含义不明确的元素添加注释。
-不要使用混乱的注释。
-在部署项目前,将多余的注释从代码中删除。


2向类添加注释

-典型的类或接口文件中的两类注释分别为文档注释 和实现注释。



三.ActionScript 编码约定

1将 ActionScript 代码保存在一个位置

2应尽可能将 ActionScript 2.0 代码放在一个位置,如一个或多个外部 ActionScript 文件或时间轴的第 1 帧上(将代码放在时间轴上时,该代码称为帧脚本)。
不要将代码附加到对象




四.处理范围

1避免使用绝对目标(_root)

2使用_lockroot

3使用 this 关键字



五.构建类文件

1不要在一行放置多项声明。

2在声明时初始化局部变量。

3使用变量前应先声明。

4避免使用隐藏更高级声明的局部声明。

5不要在语句中为多个变量赋一个值。

6只有在出于某一原因需要公开时才将方法或属性设置为公共。否则,应将方法和属性设置为私有。

7将大多数成员变量设置为私有变量,除非有好的理由将其设置为公共变量。

8类变量应在前加"m_" eg:m_abc

9使用 trace 语句

10如果引用父类中的某个方法,可为该方法加上 super 前缀,这样其他开发人员就知道从何处调用该方法。

11避免使用 with 语句

六.关于使用函数
1尽可能重复使用代码块。一种重复使用代码的方法是多次调用一个函数,而不是每次都创建不同的代码。
七.ActionScript 和 Flash Player 优化
1避免从一个循环中多次调用一个函数。
2尽可能使用本机函数。
3不要过多使用 Object 类型。
4避免使用 eval() 函数或数据访问运算符。
5在开始循环前将 Array.length 赋予变量。

 

分享 分享 |  评论 (0) |  阅读 (?)  |  固定链接 |  类别 (ActionScript3.0) |  发表于 12:26
搜狐博客温馨提示:搜狐博客官方不会要求参加活动的各位博友缴纳任何的手续费用。请勿轻信留言、评论中的中奖信息,更不要拨打陌生电话及向陌生帐户汇款,谨防受骗!识别更多网络骗术,请 点击查看详情
您还未登录,只能匿名发表评论。或者您可以 登录 后发表。
 
  *中国人爱国心,搜狗输入法爱国主题皮肤下载>>
表  情:
加载中...
回复通知: 同时用小纸条通知对方该回复