Adobe Flex编码指南

Adobe Flex编码指南v1.2 flex编码指南（规范）目录一、介绍：二、文件2 1文件扩展名2 2文件名2 3编码三、ActionScript 3 0 3 1文件结构3 2样式3 2 1行与换行3 2 2声明3 2 3括号3 2 4声明3 2 5换行与空格3 3注释3 3 1文档注释3 3 2执行注释四、MXML 4 1文件结构4 2样式4 2 1行与换行4 2 2 Nstlingcomponents（雏鸟组件？） 4 2 3属性4 2 4脚本4 3注释4 3 1文档注释4 3 2执行注释五、样式5 1一般规则六、命名6 1一般规则6 2语言6 3包6 4类6 5接口6 6方法6 7变量6 8常量6 9命名空间七、一般习惯八、附录：预留关键字### Adobe Flex编码指南知识点解析####一、介绍- **目标**:本指南旨在为使用Adobe Flex 2及ActionScript 3编写应用程序提供一套标准的编码规范。其核心目的是提高代码的可读性和可维护性，使得即便是非原作者也能轻松理解和维护代码。 - **原则**:通用性和易理解性是制定本规范的关键原则。 ####二、文件- **2.1文件扩展名** - MXML代码文件应使用`.mxml`扩展名。 - ActionScript代码文件应使用`.as`扩展名。 - CSS代码文件应使用`.css`扩展名。 - **2.2文件名** -文件名中不得包含空格、标点或其他特殊符号。 -对于ActionScript文件： -类和接口采用首字母大写的驼峰式命名法，如`ExampleClassName`。 -接口名称以大写字母“I”开头，如`IExampleInterface`。 -包含文件（例如资源文件）采用首字母小写的驼峰式命名法，如`exampleResource`。 -命名空间采用首字母小写的驼峰式命名法，如`myNamespace`。 -对于MXML文件，文件名始终采用首字母大写的驼峰式命名法。 -对于CSS文件，文件名始终采用首字母小写的驼峰式命名法。 - **2.3编码** -所有文件必须使用UTF-8编码。 ####三、ActionScript 3.0 - **3.1文件结构** -每个ActionScript文件应包含： -开篇注释。 -定义包。 -声明命名空间。 -导入描述。 -使用命名空间的声明。 -元数据声明。 -包和接口定义。 -静态变量定义。 -变量定义（不使用getter和setter）。 -构造函数定义。 -使用getter和setter的变量和方法定义。 - **导入描述**应遵循以下规则： -按照`flash`包、`mx`包、`com.adobe`包等顺序进行导入，并且每个类别内的导入按照字母顺序排列。 -尽可能避免使用通配符（*），而应具体指定需要导入的类。 - **命名空间使用**： -如果使用了命名空间，则应在文件中明确声明，并按字母顺序排列。 ####四、MXML - **4.1文件结构** - MXML文件的结构应当清晰，便于阅读和维护。 - **4.2样式** - **行与换行**： -应当保持一致的换行风格，以增强可读性。 - **属性**： -属性应当有序地排列，并保持良好的格式化。 - **脚本**： -内联脚本应当简洁明了；复杂逻辑建议放在外部ActionScript文件中。 - **4.3注释** - **文档注释**用于描述组件的功能、参数等。 - **执行注释**用于解释代码的具体实现细节。 ####五、样式- **5.1一般规则** -为了确保代码的一致性和可读性，应遵循统一的编码风格。 ####六、命名- **6.1一般规则** -统一使用驼峰式命名法。 - **6.2语言** -使用英文作为编程语言的标准。 - **6.3包** -命名空间应当反映其功能或所属模块。 - **6.4类** -类名采用首字母大写的驼峰式命名法。 - **6.5接口** -接口名以“I”开头，后跟类名。 - **6.6方法** -方法名采用首字母小写的驼峰式命名法。 - **6.7变量** -变量名采用首字母小写的驼峰式命名法。 - **6.8常量** -常量名全为大写，单词间用下划线分隔。 - **6.9命名空间** -命名空间采用首字母小写的驼峰式命名法。 ####七、一般习惯- **7.1一般习惯** -遵循业界标准的最佳实践，比如DRY（Don't Repeat Yourself）原则。 ####八、附录：预留关键字- **关键词列表** -提供一份保留关键字列表，以避免在命名时使用这些关键字。通过以上详细的解析，我们可以看出Adobe Flex编码指南涵盖了从文件命名到具体的编码规范等多个方面，旨在帮助开发者编写高质量、可维护的代码。这不仅有助于团队内部协作，也有利于项目长期发展。