Flex代码规范:MXML与ActionScript 3最佳实践

档概述了Adobe Flex应用程序中MXML和ActionScript 3代码的推荐规范。内容涵盖文件结构、命名约定、代码组织和注释等方面,提高代码可读性、可维护性和一致性。

文件结构与命名

  • 文件扩展名: 使用 .mxml 表示MXML文件,.as 表示ActionScript文件。
  • 文件名: 采用PascalCase命名法(例如,MyComponent.mxml)。
  • 编码: 使用UTF-8编码。

代码组织与样式

  • 缩进: 使用四个空格进行缩进,避免使用制表符。
  • 行长度: 每行代码不超过120个字符,必要时进行换行。
  • 声明: 每个变量、常量、函数等都应进行明确的声明。
  • 花括号: 左花括号与语句位于同一行,右花括号单独占一行。
  • 语句分隔: 使用分号结束每个语句。

注释规范

  • 文档注释: 使用ASDoc语法编写文档注释,用于生成API文档。
  • 实现注释: 使用单行或多行注释解释代码逻辑和实现细节。

MXML规范

  • 组件交织: 合理组织MXML标签,保持代码结构清晰易懂。
  • 脚本块: 使用 标签嵌入ActionScript代码。

ActionScript 3规范

  • 命名规范:
    • 包名: 使用小写字母,例如 com.example.mypackage
    • 类名: 使用PascalCase命名法,例如 MyClass
    • 接口名: 使用PascalCase命名法,以字母I开头,例如 IMyInterface
    • 方法名: 使用camelCase命名法,例如 myMethod
    • 变量名: 使用camelCase命名法,例如 myVariable
    • 常量名: 使用大写字母和下划线分隔单词,例如 MY_CONSTANT
  • 命名空间: 使用命名空间避免命名冲突。

附录

  • 保留字: 避免使用ActionScript 3中的保留字作为标识符。

文档历史

  • 版本1.0: 初始版本
pdf 文件大小:628.66KB