java開發規範與基本原則(pdf 37頁)

目錄
第1章 緒論..................5
1.1 目的..................5
1.2 範圍..................5
1.3 版權聲明..................5
1.4 參考資料..................5
1.5 概述..................5
第2章 代碼組織與風格................7
2.1 基本原則..................7
2.2 縮進..................7
2.3 長度..................7
2.4 行寬..................7
2.5 間隔..................7
2.6 對齊..................7
2.7 括號..................8
第3章 注釋..................9
3.1 基本原則..................9
3.2 JAVADOC..................9
3.3 文件與包注釋................9
3.4 類、接口注釋................10
3.5 方法注釋..................10
3.6 其他注釋..................11
3.7 注釋參考表................11
第4章 命名..................13
4.1 基本原則..................13
4.2 文件、包..................13
4.3 類、接口..................13
4.4 字段..................14
4.5 方法..................14
4.6 異常..................15
4.7 命名約定表................15
第5章 聲明..................17
5.1 基本原則..................17
5.2 包..................17
5.3 類、接口..................17
5.4 方法..................17
5.5 字段..................18
5.6 示例..................18
第6章 類與接口................20
6.1 基本原則..................20
6.2 抽象類與接口................20
6.3 繼承與組合................20
6.4 構造函數和靜態工廠方法...............20
6.5 TOSTRING(),EQUALS(),HASHCODE()............20
6.6 SINGLETON CLASS...............22
第7章 方法..................23
7.1 基本原則..................23
7.2 參數和返回值................23
第8章 表達式與語句................24
8.1 基本原則..................24
8.2 控製語句..................24
8.3 循環語句..................25
第9章 錯誤與異常................26
9.1 基本原則..................26
9.2 已檢查異常與運行時異常...............26
9.3 異常的捕捉與處理................26
第10章 測試與BUG跟蹤................27
10.1 基本原則................27
10.2 測試驅動開發................27
10.3 JUNIT單元測試................27
10.4 自動測試與持續集成...............27
10.5 BUG跟蹤和缺陷處理...............27
第11章 性能與安全................28
11.1 基本原則................28
11.2 STRING與STRINGBUGFFER...............28
11.3 集合..................28
11.4 對象..................28
11.5 同步..................28
11.6 FINAL..................28
11.7 垃圾收集和資源釋放...............29
第12章 其他..................30
12.1 目錄結構................30
12.2 CVS注釋與標記................31
12.3...................31
第13章 附錄..................32
13.1 CVS標識符................32
13.2 注釋模板................32
13.3 常用縮寫簡表................33
13.4 版權聲明模板................33
13.5 示例代碼................34

第1章 緒論
1.1 目的
本規範的目的是使本組織能以標準的、規範的方式設計和編碼。通過建立編碼規範，以使每個開發人員養成良好的編碼風格和習慣；並以此形成開發小組編碼約定，提高程序的可靠性、可讀性、可修改性、可維護性和一致性等，增進團隊間的交流，並保證軟件產品的質量。
1.2 範圍
本規範適用於“Skyinn Group”及其下所有軟件項目、產品等的設計、開發以及維護、升級等。
本規範使用於“Skyinn Group”的所有軟件開發人員，在整個軟件開發過程中必須遵循此規範。
1.3 版權聲明
本文檔為共享文檔，不限轉載，但請保持本文檔的完整性。
您可以修改本文檔以符合您或組織、公司等之實際，但請在文檔中保持對本文檔的引用和說明。
未經本人授權，任何個人、組織或單位不得將本文檔用於書麵發表、轉載、摘錄等，亦不得用於其他商業行為。
本人及本組織不承擔任何因使用、參考本文檔等而導致的任何可能責任或連帶責任。

..............................