Java編碼規範(一)
阿新 • • 發佈:2022-04-20
一、基本原則
儘管編寫效能良好的軟體很重要。但專業Java開發人員也應當考慮許多其他問題;編寫具有風格的軟體是可預測的、健壯的、可維護的、可支援的和可擴充套件的。
(1)堅持原有的風格
當修改現有軟體時,您的更改應該遵循原始程式碼的風格,不要在修改中引入新的編碼風格,並且不要嘗試重寫舊軟體,僅僅為了使其與新風格相符。
(2)堅持最小驚訝原則
最小驚訝原則建議你應該避免做那些將會驚嚇到你的軟體使用者的事。這意味著互動方式與行為表現的方法應該是可預見的,一致的。如果不是,那麼檔案中必須清晰的標出並且為所有不同尋常的模式作出解釋。你應該在你開發的Java軟體設計、實現和文件中強調以下的特點 :
簡單性:構建簡單的類和簡單的方法
清晰性:每個類、介面、方法、變數和物件都有明確的目的。解釋在何處、何時、為何以及如何使用它們
完整性:提供任何合理使用者期望找到和使用的最小功能模組
一致性:相似實體的外觀和行為應相同,不相似實體的外觀和行為應不同
健壯性:提供可預測的已記錄行為,以響應錯誤和異常。不要隱藏錯誤,也不要強制客戶端檢測錯誤。
(3)第一次就做對
將這些規則應用於您編寫的任何程式碼,而不僅僅是用於生產產品的程式碼,任何檢視你的程式碼的人都會欣賞你的專業性和遠見,因為你始終應用了這些規則。
(4)記錄任何偏差
沒有標準是完美的,也沒有標準是普遍適用的。有時你會發現自己需要偏離已有的標準。在你決定忽略一條規則之前,你應該首先確保你理解為什麼這個規則存在以及如果不使用該規則產生的後果。如果你決定必須違反一條規則,那麼記錄下你為什麼這麼做。