Flex+AS3编码规范指南

5星 · 超过95%的资源 需积分: 9 3 下载量 112 浏览量 更新于2024-10-16 收藏 112KB DOCX 举报
"flex+AS3编程规范.docx" 在Flex和AS3的编程环境中,遵循一套严谨的编程规范至关重要,这不仅可以提高代码的可读性和可维护性,还能确保团队间的协作更加顺畅。以下是一些关于Flex+AS3编程的关键点: 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`。 - 事件类:以`Event`结尾,如`FoobarEvent.as`。 - 命令类:直接命名,如`TestCommand.as`。 - 皮肤类:以具体对象命名,如`FooBarBackground`,`FooBarBorder`,`FooBarIcon`。 - utility类:以单数形式命名,如`FooBarUtil`,包名通常用复数,如`utils`。 4. **包**: - 包名小写字母开头,后续单词首字母大写,如`controls`,`listClasses`。 - 包名应反映其功能,动名词如`binding`,`logging`,`messaging`,`printing`等。 - 支持特定组件的包,如`fooBarClasses`,应以组件名称开头。 - 包的导入应使用完整包名,避免使用通配符`*`,除非使用了包中的大部分类。 - 包的结构通常为:顶级域(如`com`,`org`等)+所有者名称+项目名+模块名,如`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. **变量名**: - 全局变量可使用类型缩写开头,后面跟有意义的名称,例如`var numItems:uint`表示整型变量,用于存储项目数量。 - 局部变量通常不使用类型缩写,直接使用描述性的名称,如`var itemIndex:int`。 9. **函数名**: - 函数名也遵循驼峰命名法,描述函数行为,如`getUserName()`,`saveData()`。 10. **注释**: - 应提供清晰的注释来解释代码的功能和用途,包括类、函数和变量的注释。 - 使用`//`进行单行注释,使用`/* */`进行多行注释。 遵循这些规范可以极大地提高代码质量,降低理解成本,同时也能提高代码审查和调试的效率。在团队开发中,一致的编码风格能确保所有成员都能快速适应并融入到项目中。
2023-06-10 上传