Flex 编程规范

http://www.adobe.com/cn/devnet/flex/articles/best_practices_pt2_07.html

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

Flex 开发最佳做法回顾

这些做法可以应用到所有 Flex 应用程序。请查看这些做法:

创建和使用 assets 目录

使用 assets 目录中的子目录

使用 SWF 目录

使用 images 目录

使用 fonts 目录

使用 audio 目录

使用 video 目录

使用 XML 目录

不要将动词、形容词或副词用于软件包名称

将复数名词用于软件包

根据软件包中的类命名软件包

使用类推动 OOP

将名词用于类名称

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

使实例变量与自变量匹配

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

将类类型 (formatter、validator、event 和 error) 加在类名称后面

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

考虑将“Base”加到超类名称后面

不要在类名称中使用空格

在方法之间使用空行

尽可能编写为接口

接口名称应当为形容词

使用有意义、描述性的变量名称

每行源代码声明一个变量

以一个空行分隔每个变量声明

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

避免将通用名称“object”用于变量

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

包含“can”、“is”或“has”的前缀布尔变量名称

大写常量变量

使常量字符串变量名称与它们的内容匹配

在方法名称中包含动词

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

按功能将方法归类

将 getter 方法放在 setter 方法上面

使用 ASDoc 样式注释对各个方法做出注释

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

始终对方法签名使用访问修改符

指定方法自变量的类型

将 setter 方法的自变量命名为“value”

将事件处理函数的自变量命名为“event”

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

使用空格将关键字与括号分隔开

组织 ActionScript 类

用四个空格将每个新的代码块缩进

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

使用空格提高代码可读性

组织 MXML 元素属性

将 ID 属性放在 MXML 元素的第一个属性位置

将相关属性归入同一行

将 MXML 元素的相关属性分组

将元标记放在它们标记的属性或方法上面

使用空行组织 MXML

组织 MXML 文档

避免内联 CSS

最小化和清理 CSS

将类似的样式定义分组

注释样式

将 CSS 声明限制为每行一个

将 UpperCamelCase ( 第一个词的首字母, 以及后面每个词的首字母都大写) 用于类型选择器名称

尽可能使用类选择器而不是类型选择器

为类选择器名称使用 lowerCamelCase (第一个词的首字母小写, 后面每个词的首字母大写)

避免在类选择器名称中使用下划线

避免根据外观命名类选择器

使用一致的命名系统

遵循标准 ASDoc 注释格式

使用空格和前导星号提高注释的可读性

使用受支持的 HTML 对 ASDoc 输出进行格式化

为主要描述编写完整而简洁的第一句

为每个类创建实用的注释

使用 @private 对 ASDoc 隐藏类

如果方法包含返回类型, 则使用 @return

将 @see 用于存在关系的项目

不要在 ASDoc 注释中使用特殊字符

注释文本应当始终在任何 @ 标记之前

描述变量的使用方式

为所有方法和接口创建实用注释

为事件类型使用标准类路径

创建用例

考虑使用 UML

考虑使用代码生成

考虑使用设计模式

考虑使用应用程序开发框架

将框架用于基于小组的开发工作

知道何时不用框架

测试行为而不是测试方法

使用“太简单, 所以不会出错”规则

在测试用例中使用标准 OOP 最佳做法

使用简洁、明确的测试方法名称

编写简单的测试用例方法

尽可能在声明方法中使用静态值

记录测试代码

创建独立单元测试

将声明限制为每个测试用例一个