flex编写标准

转自郭少瑞博客

 

处理资源：

1. 创建和使用“assets”目录
2. 使用 assets 目录中的子目录
3. 使用 SWF 目录src/assets/swf
4. 使用 images 目录src/assets/images
5. 使用 fonts 目录src/assets/fonts
6. 使用 audio 目录
7. 使用 video 目录
8. 使用 XML 目录

ActionScript 3.0 编码标准

1. 不要将动词、形容词或副词用于软件包名称
2. 将复数名词用于软件包
3. 根据软件包中的类命名软件包
4. 将类主体中定义的可执行代码量降最低
5. 使实例变量与自变量匹配
6. 创建类时使用经典的一般惯例
7. 将类类型 (formatter、validator、event 和 error) 加在类名称后面
8. 将外观类型加到类名称后面
9. 考虑将“Base”加到超类名称后面
10. 在方法之间使用空行
11. 尽可能编写为接口
12. 使用有意义的变量名称
13. 选择描述性的变量名称
14. 每行源代码声明一个变量
15. 以一个空行分隔每个变量声明
16. 使用 ASDoc 样式注释对各个变量做出注释
17. 避免通用名称“object”
18. 始终为变量使用较强的类型
19. 包含“can”、“is”或“has”的前缀布尔变量名称
20. 大写常量变量
21. 使常量字符串变量名称与它们的内容匹配
22. 为 getter/setters 在变量前加下划线
23. 在方法名称中包含动词
24. 将代码限制为每行一个语句
25. 按功能将方法归类
26. 将 getter 方法放在 setter 方法上面
27. 使用 ASDoc 样式注释对各个方法做出注释
28. 始终提供一个返回类型, 即使它是空的 (不返回任何内容) 或 * (任何类型)
29. 始终对方法签名使用访问修改符
30. 指定方法自变量的类型
31. 将事件处理函数的自变量命名为“event”
32. 不要使用空格将方法名称和括号分隔开
33. 使用空格将关键字与括号分隔开
34. 组织 ActionScript 类
35. 用四个空格将每个新的代码块缩进
36. 用一个空行分隔每个类中的各个方法
37. 使用空格提高代码可读性

MXML 编码标准

1. 组织元素属性
2. 将 ID 属性放在第一个属性位置
3. 将相关属性归入同一行
4. 将相关属性分组
5. 使用空行组织 MXML
6. 组织 MXML 文档

Flex 的 CSS 编码标准

1. 避免内联 CSS
2. 最小化和清理 CSS
3. 将类似的样式定义分组
4. 注释样式
5. 将 CSS 声明限制为每行一个
6. 尽可能使用类选择器而不是类型选择器
7. 为类选择器名称使用 lowerCamelCase (第一个词的首字母小写, 后面每个词的首字母大写)
8. 避免在类选择器名称中使用下划线
9. 避免根据外观命名类选择器
10. 使用一致的命名系统

为 ASDoc 注释 ActionScript 源代码

1. 遵循使用的标准 ASDoc 注释格式
2. 使用空格和前导星号提高注释的可读性
3. 使用受支持的 HTML 对 ASDoc 输出进行格式化
4. 为主要描述编写完整而简洁的第一句
5. 为每个类创建实用的注释
6. 使用 @private 对 ASDoc 隐藏类
7. 如果方法包含返回类型, 则使用 @return
8. 将 @see 用于存在关系的项目
9. 不要在 ASDoc 注释中使用特殊字符
10. 注释文本应当始终在任何 @ 标记之前
11. 描述变量的使用方式
12. 为所有方法和接口创建实用注释
13. 为事件类型使用标准类路径

应用程序架构

1. 创建用例
2. 考虑使用 UML
3. 考虑使用代码生成
4. 考虑使用设计模式

应用程序开发框架

1. 考虑使用应用程序开发框架
2. 将框架用于基于小组的开发工作(Mate,Cairngorm,PureMVC)
3. 知道何时不用框架
4. 测试行为而不是测试方法
5. 使用“太简单, 所以不会出错”规则
6. 在测试用例中使用标准 OOP 最佳做法
7. 使用简洁、明确的测试方法名称
8. 编写简单的测试用例方法
9. 尽可能在声明方法中使用静态值
10. 记录测试代码
11. 创建独立单元测试
12. 将声明限制为每个测试用例一个