Flex编码规范指南:命名与结构详解

需积分: 3 1 下载量 5 浏览量 更新于2024-09-16 收藏 112KB DOCX 举报
在Flex编程中,编码规范对于代码的可读性、可维护性和团队协作至关重要。以下是一些关于Flex项目中常见的编码规范,这些规则将帮助开发者确保代码质量并提升开发效率。 1. **缩写**: - 应避免过多使用缩写,除非它们在Flex社区中已经被广泛接受。例如,acc代表accessibility(可访问性),auto指代automatic(自动的),impl表示implementation(实现),而info则表示information(信息)。其他常见的缩写还包括num(number)、min(minimum)、max(maximum)、nav(navigation)、regexp(regular expression)和util(utility)等。 2. **文件命名**: - MXML文件遵循驼峰式命名法,如`Main.mxml`和`FlvPlayer.mxml`。CSS文件则采用小写开头,单词之间大写,如`testStyle.css`。 3. **类名**: - 类名由多个单词组成,首字母大写,如`EditTest.as`。特定类型的类名有特定格式: - 事件类:如`FoobarEvent.as` - 命令类:如`TestCommand.as` - 皮肤类:如`FooBarBackground`, `FooBarBorder`, `FooBarIcon` - utility类:如`FooBarUtil`,注意单数形式,且包名为复数,如`fooBarClasses`。 4. **包结构**: - 包名应以小写字母开头,单词之间大写,如`controls`或`listClasses`。包名应反映其功能或所属关系,动名词常用,如`bingding`、`logging`、`messaging`和`printing`。针对具体组件的包名应为`fooBarClasses`。 - 导入包时,尽量使用完整的应用名而非星号,除非涉及大量子包。例如,包路径可以是`cn.com.company.project.module`。 5. **命名空间**: - 使用小写字母和下划线进行分隔,文件名应与命名空间名称一致。例如,`mx_internal`和`object_proxy`。 6. **接口名称**: - 接口名通常以"I"开头,后续由大写字母隔开,如`IList`, `IFocusManager`, `IUID`。 7. **常量命名**: - 常量全大写,单词之间用下划线分隔,如`OFF`、`DEFAULT_WIDTH`。如果常量是字符串,应保持一致的命名格式,如`<public static const FOO_BAR:String = "fooBar">`。 8. **变量命名**: - 全局变量通常以类型缩写开头,后跟有意义的描述,以便理解变量用途,如`m_currentDate:Date`。 遵循这些编码规范能够提高代码的一致性和可读性,降低维护成本,同时也有助于跨团队合作。在实际开发过程中,灵活运用并持续优化这些规则,将有助于构建出高质量的Flex应用程序。