JAVA 編碼規範

1. 明白需求分析, 弄懂各個模塊的實現功能.
2. 制定項目的專業術語(terminology), 如客戶使用 customer 而不是client , 路徑使用path 而不是 way.
3. 制定項目的注釋規範, 如類一定要寫明白這個類的功能, 這個類的編寫原因, 與有可能出現的異常.
4. 確定項目的運行路徑, 測試代碼的運行路徑, 類與接口的保存路徑,並且使它們統一.

一   類名稱的編寫規範

1. 名稱的第一個字母大寫, 如果多個單詞組成類的名稱, 那麼每個單詞的第一個字母大寫.
2. 編寫簡潔, 適當的文檔描述, 如該類實現的功能, 編寫該類的原因, 該類繼承了那些自定義類,該類存在哪些不足及可以改進的地方. 類內說明應該不超過800*600的一個屏幕範圍.

二  接口名稱的編寫規範

1. 名稱的第一個字母大寫, 如果多個單詞組成類的名稱, 那麼每個單詞的第一個字母大寫.
2. 採用描述性的名字描述接口, 如: Cloneable,Comparable,Runnable等,使用的英文後綴如 ble, er, Modeld等.
3. 在名稱的前面採用" I ", 或者在名稱的後面採用 "Ifc" 標示接口, 或者更為詳細地在名稱前面使用"Interface"標識接口.
4. 編寫簡潔, 適當的文檔描述, 如接口的編寫原因, 接口的實現功能.

三  類包名稱的編寫規範

1. 名稱的所有字母均為小寫形式.
2. 類包使用字符"."代替路徑字符"/". 如: java.awt.*;  java.io.*;

四  函數名稱的編寫規範

1. 第一個單詞的所有字母小寫, 其餘單詞的第一個字母大寫.
2. 設置內部變量的函數使用關鍵字set 開頭.
3. 獲取內部變量的函數使用關鍵字get 開頭.
4. 返回布爾值的函數使用關鍵字 is , has , can 等開頭.

五  參數名稱的編寫規範

1. 第一個單詞的所有字母小寫, 其餘單詞的第一個字母大寫.
2. 使用a 或者 an 作為參數的開頭, 那麼其後的單詞的第一個字母大寫.
3. 使用適當的文檔說明, 如該參數的作用, 使用該參數要注意的問題.

六  屬性名稱的編寫規範

1. 第一個單詞的所有字母小寫, 其餘單詞的第一個字母大寫.
2. 在名稱前面使用字母標識屬性的變量類型, 其餘單詞的第一個字母大寫. 如 數字變量 ; iCode , 字符變量: sName.
3. 在屬性的前面或者後面使用符號 "_" 標識該變量是屬性.
4. 使用適當的文檔說明對屬性進行解釋.

七  控件名稱的編寫規範

1. 名稱的第一個單詞全部小寫, 其餘單詞的第一個字母大寫.
2. 名稱的後面以空間名稱作為結束.

八  本地變量名稱的編寫規範

1. 文件流的名稱要符合如下的編寫規範: 1) 首字母使用 in 或者 out 標識讀入或者是讀出操作,也可以使用 input 或者 output . 2) 名稱可以使用Stream 作為結束單詞.
2. 循環體的內部變量可以使用 i, j, k, counter1, counter2 等.
3. 異常類的名稱可以使用 "e" 字符作為開頭.

九  常量名稱的編寫規範

1. 所有字母大寫.
2. 單詞與單詞間使用分隔符 "_" .

十  集合名稱的編寫規範

1. 名稱的第一個字母小寫, 其餘單詞的首字母大寫.
2. 使用字符 "s" 結束.