1. 創建和使用“assets”目錄 2. 使用 assets 目錄中的子目錄 3. 使用 SWF 目錄src/assets/swf 4. 使用 images 目錄src/assets/images 5. 使用 fonts 目錄src/assets/fonts
基本介紹
- 中文名:Flex最佳做法
- 適用領域:計算機
- 所屬學科:計算機科學
- 用途:處理資源
處理資源,編碼標準,應用程式架構,MX編碼標準,CSS編碼標準,ASDoc注釋,
處理資源
1. 創建和使用“assets”目錄
2. 使用 assets 目錄中的子目錄
3. 使用 SWF 目錄src/assets/swf
4. 使用 images 目錄src/assets/images
5. 使用 fonts 目錄src/assets/fonts
6. 使用 audio 目錄
7. 使用 video 目錄
8. 使用 XML 目錄
編碼標準
1. 不要將動詞、形容詞或副詞用於軟體包名稱
2. 將複數名詞用於軟體包
3. 根據軟體包中的類命名軟體包
4. 將類主體中定義的可執行代碼量降最低
5. 使實例變數與自變數匹配
6. 創建類時使用經典的一般慣例
7. 將類類型 (formatter、validator、event 和 error) 加在類名稱後面
8. 將外觀類型加到類名稱後面
9. 考慮將“Base”加到超類名稱後面
10. 在方法之間使用空行
11. 儘可能編寫為接口
12. 使用有意義的變數名稱
13. 選擇描述性的變數名稱
14. 每行原始碼聲明一個變數
15. 以一個空行分隔每個變數聲明
16. 使用 ASDoc 樣式注釋對各個變數做出注釋
17. 避免通用名稱“object”
18. 始終為變數使用較強的類型
19. 包含“can”、“is”或“has”的前綴布爾變數名稱
20. 大寫常量變數
21. 使常量字元串變數名稱與它們的內容匹配
22. 為 getter/setters 在變數前加下劃線
23. 在方法名稱中包含動詞
24. 將代碼限制為每行一個語句
25. 按功能將方法歸類
26. 將 getter 方法放在 setter 方法上面
27. 使用 ASDoc 樣式注釋對各個方法做出注釋
28. 始終提供一個返回類型, 即使它是空的 (不返回任何內容) 或 * (任何類型)
29. 始終對方法簽名使用訪問修改符
30. 指定方法自變數的類型
31. 將事件處理函式的自變數命名為“event”
32. 不要使用空格將方法名稱和括弧分隔開
33. 使用空格將關鍵字與括弧分隔開
34. 組織 ActionScript 類
35. 用四個空格將每個新的代碼塊縮進
36. 用一個空行分隔每個類中的各個方法
37. 使用空格提高代碼可讀性
應用程式架構
1. 創建用例
2. 考慮使用 UML
3. 考慮使用代碼生成
4. 考慮使用設計模式
應用程式開發框架
1. 考慮使用應用程式開發框架
2. 將框架用於基於小組的開發工作(Mate,cairngorm,PureMVC)
3. 知道何時不用框架
4. 測試行為而不是測試方法
5. 使用“太簡單, 所以不會出錯”規則
6. 在測試用例中使用標準 OOP 最佳做法
7. 使用簡潔、明確的測試方法名稱
8. 編寫簡單的測試用例方法
9. 儘可能在聲明方法中使用靜態值
10. 記錄測試代碼
11. 創建獨立單元測試
12. 將聲明限制為每個測試用例一個
MX編碼標準
1. 組織元素屬性
2. 將 ID 屬性放在第一個屬性位置
3. 將相關屬性歸入同一行
4. 將相關屬性分組
5. 使用空行組織 MXML
6. 組織 MXML 文檔
CSS編碼標準
1. 避免內聯 CSS
2. 最小化和清理 CSS
3. 將類似的樣式定義分組
4. 注釋樣式
5. 將 CSS 聲明限制為每行一個
6. 儘可能使用類選擇器而不是類型選擇器
7. 為類選擇器名稱使用 lowerCamelCase (第一個詞的首字母小寫, 後面每個詞的首字母大寫)
8. 避免在類選擇器名稱中使用下劃線
9. 避免根據外觀命名類選擇器
10. 使用一致的命名系統
ASDoc注釋
為ASDoc注釋ActionScript原始碼:
1. 遵循使用的標準 ASDoc 注釋格式
2. 使用空格和前導星號提高注釋的可讀性
3. 使用受支持的 HTML 對 ASDoc 輸出進行格式化
4. 為主要描述編寫完整而簡潔的第一句
5. 為每個類創建實用的注釋
6. 使用 @private 對 ASDoc 隱藏類
7. 如果方法包含返回類型, 則使用 @return
8. 將 @see 用於存在關係的項目
9. 不要在 ASDoc 注釋中使用特殊字元
10. 注釋文本應當始終在任何 @ 標記之前
11. 描述變數的使用方式
12. 為所有方法和接口創建實用注釋
13. 為事件類型使用標準類路徑