Flex_SDK编码规范及最佳实践.docVIP

Flex SDK 编码规范及最佳实践 注意:本文档目前还不完整且有些部分以TBD(待讨论)标记, 但这对于起步已经足够了! 引言 这篇文档拟定了用AS3编写开源Flex框架组件的编码规范. 遵照这些规范可以使得源代码看起来组织良好,风格一致并且更加专业.其中有些规范是很任意的,因为并非总存在一种”最好方式”来编码. 然而,为了照顾一致性的要求,所有付诸Flex SDK的项目都将遵循这些编码规范. 目录 命名 缩写词 缩略语 单词定界 类型指定名 包名 文件名 命名空间名 接口名 类名 事件名 样式名 字符串属性枚举值 常量名 属性 (变量和getter/setter) 名 存储变量名 方法名 事件处理方法名 参数名 资源包名 资源键名 杂项名 语言用法 编译选项 基于属性的 APIs 类型定义 Literals Expressions Statements Declarations 文件组织 Copyright notice package statement import statements use namespace statement Class metadata Class declaration include statement for Version.as Implementation notes Class initialization Class constants Class mix-ins Class resources Class variables Class properties Class methods Constructor Variables Overridden properties Properties Overridden methods Methods Overridden event handlers Event handlers Out-of-package helper classes 格式化 Line width Indentation Section separators Separation of declarations Metadata Array indexing Commas Array literals Object literals Function literals Type declarations Operators and assignments Statements Constant and variable declarations Function declarations Function calls if statements for statements switch statements class and interface declarations ASDoc文档 Property comments 命名 缩写词 作为通用规则而避免使用.例如calculateOptimalValue()比calcOptVal()的命名方式更优. acc 代表 accessibility, 比如 ButtonAccImpl auto 代表automatic, 比如autoLayout eval 代表evaluate, 比如EvalBindingResponder impl 代表implementation, 比如ButtonAccImpl info 代表information, 比如GridRowInfo num 代表number of, 比如numChildren min 代表minimum, 比如minWidth max 代表maximum, 比如maxHeight nav 代表navigation, 比如NavBar regexp 代表regular expression, 比如RegExpValidator util 代表utility, 比如StringUtil 编码时采用合适的命名既便于使用且理解起来也更为容易.所以你得在选择好的命名方式二多费心力,特别是针对公共API提供出来的时候. 我们的命名规范绝大部分和ECMAScript和Flash Player 9 是一致的. 表意明确比为了少敲几下代码而采用缩写更为重要. 如果你不使用缩写,开发人员就不用非得记住你是否采用了单词简写,如把”qualified”简写成”qual”或”qlfd”. 不过,我们已经标准化了一些缩写词: 上述列表可能没有包含目前使用的所有缩写词.如果你用到了上面没有列举出来的缩写词,请搜索源代码看是否已经有相应的缩写词使用了.如果没发现,再考虑一下如果缩写是否合适. 在Flex中有各种缩略语，像AIR, CSS, HLOC, IME, MX, MXML, RPC