原文地址:http://www.adobe.com/cn/devnet/flex/articles/best_practices_pt2_02.html
MXML 编码标准
- 组织元素属性
- 将 ID 属性放在第一个属性位置
- 将相关属性归入同一行
- 将相关属性分组
- 使用空行组织 MXML
- 组织 MXML 文档
Flex 的 CSS 编码标准
- 避免内联 CSS
- 最小化和清理 CSS
- 将类似的样式定义分组
- 注释样式
- 将 CSS 声明限制为每行一个
- 尽可能使用类选择器而不是类型选择器
- 为类选择器名称使用 lowerCamelCase (第一个词的首字母小写, 后面每个词的首字母大写)
- 避免在类选择器名称中使用下划线
- 避免根据外观命名类选择器
- 使用一致的命名系统
为 ASDoc 注释 ActionScript 源代码
- 遵循使用的标准 ASDoc 注释格式
- 使用空格和前导星号提高注释的可读性
- 使用受支持的 HTML 对 ASDoc 输出进行格式化
- 为主要描述编写完整而简洁的第一句
- 为每个类创建实用的注释
- 使用 @private 对 ASDoc 隐藏类
- 如果方法包含返回类型, 则使用 @return
- 将 @see 用于存在关系的项目
- 不要在 ASDoc 注释中使用特殊字符
- 注释文本应当始终在任何 @ 标记之前
- 描述变量的使用方式
- 为所有方法和接口创建实用注释
- 为事件类型使用标准类路径