Flex SDK编码约定和最佳实践.pdfVIP

Flex SDK 编码约定和最佳实践 高灵超 2009-5-30 北京许继电气有限公司 Flex SDK 编码约定和最佳实践 修订历史： 版本 修订时间 修订人 主要内容 备注 V1.0 2009-5-30 高灵超 翻译 北京许继电气有限公司 2 Flex SDK 编码约定和最佳实践 目录 Flex SDK 编码约定和最佳实践4 序言4 目录4 命名4 语言使用10 文件组织32 文本格式32 ASDoc 41 北京许继电气有限公司 3 Flex SDK 编码约定和最佳实践 Flex SDK 编码约定和最佳实践 注：本文档还没有完成，没有完成的章节标记为 TBD。但已经完成的内容能够确保您开始您 的项目。 序言 本文档描述使用 ActionScript 3 编写 Flex 框架组件所应遵循的编程标准。坚持采纳这些标 准，能使您的代码一致、容易组织而且专业。 不存在一种最好的编码方式，所以本标准的一些条款是硬性的规定，比较武断。虽然如此， 为了项目整体的协调一致，所有采用 Flex SDK 的项目都应遵守这些约定。 目录 命名约定 语言使用 文件组织 编码格式 ASDoc 命名 选择好的名字是编写易用和易懂的代码的关键因素。你应该总是花一些时间考虑是否为一些 事情选择了正确的名字，特别是这些名字将作为公共 API 的一部分时。 我们的命名标准主要与 ECMAScript 和 Flash Player 9 一致。 缩写 尽量避免使用缩写。如：calculateOptimalValue()是一个比 calcOptVal()更好的函数名称。 保持名字的清晰比减少按键次数更加重要。如果你不使用，开发人员就不必记忆一些容易混 淆的名称，如是把“qualified”缩写成“qual”还是“qlfd”。 尽管如此，我们还是要记忆少量的一些缩写： 缩写 原词 中文 举例 acc accessibility 访问 ButtonAccImpl 北京许继电气有限公司 4 Flex SDK 编码约定和最佳实践 auto automatic 自动 autoLayout eval evaluate 计算 EvalBindingResponder impl implementation 实现 ButtonAccImpl info information 信息 GridRowInfo num number 数字 numChildren min minimum 最小 minWidth max maximum