Adobe Flex

该文档旨在为使用Adobe Flex 2和ActionScript 3编写应用程序建立编码指南。要创建通俗易懂的编码规范，因为在软件开发的生命周期中，大部分时间都是在维护。这样，易于理解的代码片段变得很重要，因为不总是最初的开发者去维护代码。通俗地说就是，让开发者能快速理解别人的代码。除此之外，程序或组件也可以方便地部署或销售给第三方。制订编码规范的前提是： z通用性z易理解性该文档中创建的实例是基于DClick的工作方法，Java编码约定和Adobe Flex 2 SDK中的约定。 ### Adobe Flex编码指南详解####一、引言Adobe Flex是一款用于构建跨平台桌面和移动设备应用程序的强大工具。它结合了MXML（一种标记语言）和ActionScript 3.0（一种强大的面向对象编程语言），使得开发者能够构建高性能且视觉效果丰富的应用程序。本文档的目标是为使用Adobe Flex 2和ActionScript 3开发应用程序提供一套统一的编码指南。制定这套指南的主要目的是为了确保代码的一致性和可读性，这对于团队合作以及后期维护至关重要。 ####二、文件规范##### 2.1文件扩展名- MXML代码：`.mxml` - ActionScript代码：`.as` - CSS代码：`.css` ##### 2.2文件命名规则- **ActionScript** -类和接口：使用开头字母大写的驼峰式命名法，例如`ExampleClassName`。 -接口：以大写字母`I`开头，例如`IExampleInterface`。 -包含文件（includes）：使用开头字母小写的驼峰式命名法。 -命名空间：使用开头字母小写的驼峰式命名法，例如`myNamespace`。 - **MXML** -总是使用开头字母大写的驼峰式命名法。 - **CSS** -总是使用开头字母小写的驼峰式命名法。 ##### 2.3编码标准-所有文件必须使用UTF-8编码。 ####三、ActionScript 3.0规范##### 3.1文件结构ActionScript文件应包含以下组成部分： 1. **注释**：包括版权信息、作者、版本等。 2. **定义包**：定义当前文件所属的包。 3. **声明命名空间**：如果使用了外部命名空间，则在此声明。 4. **Import描述**：按类别和字母顺序导入所需的库。 - flash包- mx包- com.adobe包-公司组件-第三方包-属于该文件的项目包5. **Use声明**：声明使用的命名空间，按字母顺序排列。 6. **元数据**：定义事件、样式、效果等。 7. **定义类和接口**：按照公共、内部、受保护和私有的顺序进行定义。 8. **静态变量**：包括常量和其他静态变量。 9. **非getter/setter变量**：根据访问级别进行组织。 10. **构造函数**：用于初始化对象。 11. **使用getter和setter的变量和方法**：定义getter和setter方法来控制对私有变量的访问。 ##### 3.2样式- **行与换行**：每行不超过80个字符，使用自动换行。 - **声明**：使用清晰一致的格式进行变量声明。 - **括号**：括号应该清晰可见，并且使用一致的方式。 - **换行与空格**：合理使用空格来提高代码可读性。 - **注释** - **文档注释**：用于解释复杂的逻辑或功能。 - **执行注释**：用于单行或多行注释，帮助理解代码细节。 ####四、MXML规范##### 4.1文件结构MXML文件结构应清晰且易于理解。 ##### 4.2样式- **行与换行**：保持每一行的整洁，合理使用换行。 - **嵌套组件**：合理使用缩进来表示组件之间的关系。 - **属性**：属性应在组件标签内清晰展示。 - **脚本**：使用``来封装ActionScript代码。 ##### 4.3注释- **文档注释**：描述组件的功能和用途。 - **执行注释**：用于解释特定代码块的作用。 ####五、一般样式规则- **通用性**：编码规范应适用于所有项目。 - **易理解性**：代码应当容易被他人阅读和理解。 ####六、命名规则- **一般规则**：遵循一致的命名规则。 - **语言**：使用英语作为默认语言。 - **包**：采用小写的反向域名格式，如`com.example.myapp`。 - **类**：使用开头字母大写的驼峰式命名法。 - **接口**：以大写字母`I`开头，后跟类名。 - **方法**：使用动词或动宾短语。 - **变量**：使用小写的驼峰式命名法。 - **常量**：全部使用大写字母。 - **命名空间**：使用小写的反向域名格式。 ####七、一般习惯-使用有意义的命名。 -避免使用全局变量。 -优化性能关键代码。 -尽可能使用类型安全的构造。 -遵循DRY原则（Don't Repeat Yourself）。 ####八、附录：预留关键字保留关键字不应用于变量、类或方法的命名，这些关键字包括但不限于`class`, `function`, `var`, `if`, `for`, `new`, `return`等。 ---通过遵循以上编码指南，开发团队可以创建出高质量、易于维护的代码。这些规范不仅有助于提升代码的可读性和可维护性，还可以促进团队间的协作效率。此外，对于需要部署或销售的应用程序来说，一致且标准化的编码实践也是一项重要的资产。