Flex 最佳做法

Flex 最佳做法－第 1 部分: 设置 Flex 项目

重点摘要：

Flex 项目的命名惯例

Flex 项目的命名惯例请使用以下最佳做法:

使用软件包组织和构造项目代码库。

软件包是基于 OOP 应用程序的标准。软件包代表类形式的相关 ActionScript 和 MXML 文件的逻辑分组。使用软件包和类是面向对象编程的基本要素。

要继续使用社区标准, 命名软件包时请使用以下做法:

软件包名称以应用程序所有者的顶级域 (TLD) 开头:

例如: com、net、us;

然后是应用程序所有者的名称:

例如: seantheflexguy, adobe;

然后是项目名称:

例如: burrow;

然后是相关代码文件的逻辑分组:

例如: utils、components 或其他相关项。

以下是一个使用此惯例的软件包名称:

com.seantheflexguy.burrow.view

 

Flex 最佳做法－第 2 部分: 开发做法

处理资源

Flex 应用程序通常会并入一组文件, 包括图像、CSS 文件、字体、音频剪辑和视频等不同类型的媒体。如果能保持应用程序的资源和源代码井井有条, 之后需要对软件做出更改时就可以节省时间。以下是命名和存储 Flex 应用程序相关文件时应考虑的一些一般指导方针。

使用 assets 目录中的子目录

为了有助于组织可用于应用程序的各种媒体类型, 建议您根据使用的媒体类型合理组织一些子目录。以下几点强调了子目录的一些常用做法。

使用 images 目录

将 JPG、GIF 或 PNG 文件等图像资源存储在一个名为“images”的目录中。

图像目录路径是: src/assets/images

使用 audio 目录

音频是富 Internet 应用程序中的常用媒体类型。将 MP4 和 WAV 文件等音频资源存储在一个名为“audio”的目录中。

音频目录路径是: src/assets/audio

使用 XML 目录

如果应用程序包含 XML 配置文件或不调用服务器而直接加载到应用程序的 XML 文件, 将它们一起存储到一个名为“xml”的目录中。

xml 目录路径是: src/assets/xml

图 1 所示的目录结构说明了这些惯例。

 

ActionScript 3.0 编码标准

为应用程序创作源代码时, 可以通过几种做法确保应用程序代码库的条理性和可读性。它们对于之后处理该应用程序的其他开发人员会有所帮助。如果今后需要修改这些代码, 它们也可以帮助您回忆起代码的来龙去脉。

在开发中使用软件包的最佳做法

将复数名词用于软件包

包含多个类的软件包的名称应当使用复数, 如“effects”。

 将类主体中定义的可执行代码量降最低

将可执行代码嵌入方法中。

 创建类时使用经典的一般惯例

类名应当是应用程序中独一无二的对象。对象应当有采用 UpperCamelCase (第一个词的首字母, 以及后面每个词的首字母都大写) 格式、基于单数名词的名称。例如, 如果我编写一个在线购物车系统, 我会命名两个类, ShoppingCart.as 和 Customer.as。还应当避免特别大的类。

 将外观类型加到类名称后面

创建与外观相关的类时, 将类类型加到类名称最后。例如, 使用 SubmitButtonBackground、SubmitButtonBorder 和 SubmitButtonIcon。

 在方法之间使用空行

类中的所有方法应当以一个空行分隔。它可以提高代码可扫描性以及代码可读性。

 使用有意义的变量名称

一般应避免单字符变量名称。还应避免缩写变量名称。

 每行源代码声明一个变量

尽量避免一行代码中出现多个变量声明和分配。如果一行包含多个声明, 开发人员很容易遗漏某个声明。

 使用 ASDoc 样式注释对各个变量做出注释

描述变量推理原因。尽量不要重申变量的用途, 而是描述它的使用方式。请参阅本文“为 ASDoc 注释 ActionScript 源代码”中的示例 ASDoc 注释。

 始终为变量使用较强的类型

即使类型是 (无类型), 为变量使用较强的类型有助于表明该变量的目的。类型有助于传达变量的使用和用途。类型较强的变量有一个预设数据类型, 并且只能包含这种类型的数据 (除非更改类型)。

 大写常量变量

常量变量应当全部大写并且每个单词以下划线分隔；例如: 、 和 。

常量变量是应用程序执行过程中不会改变的值。将它们大写后, 您可以将它们与一般 (非常量)变量区分开。

 为 getter/setters 在变量前加下划线

如果将通过 getter/setter 方法修改变量, 请在它们之前加下划线。

方法的最佳做法

 将代码限制为每行一个语句

避免在一行中放置多个语句。

 将 getter 方法放在 setter 方法上面

创建 getter/setter 方法时, 首先放置 getter 方法。

 始终提供一个返回类型, 即使它是空的 (不返回任何内容) 或 * (任何类型)

为所有方法提供一个返回类型。通过查看返回类型, 可以进一步理解方法的用途。

 指定方法自变量的类型

为所有自变量提供一个类型。开发人员编写调用该方法的代码时, 这可能有所帮助。

 不要使用空格将方法名称和括号分隔开

尽量编写出简洁、统一、标准化的源代码。

 组织 ActionScript 类

在整个应用程序中, 保持 ActionScript 类的条理性并使它与其余源代码保持一致。当您或其他开发人员稍后需要找到特定代码区域进行快速更改时, 这将有所帮助。

可以将以下结构作为示例:

1. 最初注释。(作者、版本、版权、代码许可证等)。
2. 软件包声明
3. 导入语句
4. 类级元数据标记: Event、Style、Effect (带注释!)
5. 类或接口实施 ASDoc 注释
6. 类或接口语句

7. 静态变量

   1. 公共
   2. 受保护
   3. 私有

8. 实例变量

      

   1. 公共
   2. 受保护
   3. 私有
9. 构造函数
10. Getter/setter 方法 (带支持变量)
11. 方法, 按功能分组

 用一个空行分隔每个类中的各个方法

创建各个方法, 使 ASDoc 文档注释直接在方法上面。然后是方法签名以及带类型的自变量 (如果自变量存在), 接着是方法主体, 最后是一个空行。

使用空格提高代码可读性

逗号后一般使用一个空格。在 和 等运算符前后使用空格。

来源：Xiang08