Flex开发中的代码规范指南

代码规范（Flex程序开发）

一、引言

在进行Flex程序开发时，遵循一套明确且统一的代码规范对于确保代码质量至关重要。良好的代码规范不仅能提高代码的可读性和可维护性，还能帮助团队成员之间更高效地协作。档详细介绍了Flex程序开发中的代码规范要求，涵盖MXML和ActionScript 3.0两个主要方面。

二、文件管理

2.1 文件扩展名

- MXML代码：应使用.mxml作为文件扩展名。

- ActionScript代码：应使用.as作为文件扩展名。

- CSS代码：应使用.css作为文件扩展名。

2.2 文件命名

- 命名规则：文件名不得包含空格、标点和特殊符号。

- ActionScript

- 类和接口使用大写字母开头的驼峰命名，如ExampleClassName。

- 接口名称需以“I”开头，如IExampleInterface。

- 包含文件和命名空间使用小写字母开头的驼峰命名法，如myNamespace。

- MXML：使用大写字母开头的驼峰命名法。

- CSS：使用小写字母开头的驼峰命名法。

2.3 编码

- 所有文件必须使用UTF-8编码。

三、ActionScript 3.0

3.1 文件结构

ActionScript文件的组织应包含以下内容：

1. 注释 - 开篇注释简述文件目的、作者信息等。

2. 定义包

3. 声明命名空间

4. Import描述 - 按顺序排列并按字母顺序排序，不使用星号通配符。

5. use声明 - 按字母顺序排序。

6. 元数据 - 按字母顺序排序，如Event、Style、Effect等。

7. 定义类和接口

8. 静态变量 - 公共、内部、受保护、私有静态变量按顺序排列。

9. 非getter/setter变量 - 按权限分组。

10. 构造函数

11. getter和setter处理的变量和方法

3.2 样式

- 行与换行：每行不超过80字符，超出需换行。

- 声明：变量和函数声明清晰明了。

- 括号和空格：合理添加空格与换行以增强可读性。

- 注释 - 使用文档注释和执行注释进行说明。

四、MXML

4.1 文件结构

MXML文件应包括：注释、包定义、命名空间声明、Import描述、MXML组件定义。

4.2 样式

- 行与换行：每行不超过80字符。

- Nesting components：合理嵌套组件以保持代码清晰。

- 属性：按类别分组正确使用属性。

五、样式

5.1 一般规则

- 统一使用四个空格缩进。

- 使用有意义的变量名和函数名，避免复杂表达式。

六、命名

6.1 一般规则

- 使用描述性名称，避免单字母变量名。

6.2 包和类

- 包使用全小写，类名以大写开头的驼峰命名。

6.3 接口和方法

- 接口以“I”开头，方法和变量以小写开头驼峰命名。

6.4 常量和命名空间

- 常量全部大写并用下划线，命名空间使用小写开头的驼峰命名。

七、一般习惯

• 遵循DRY原则，避免重复代码。

八、附录：保留关键字

ActionScript 3.0保留关键字包括package, import, public, private, class等，不可用作标识符名称。