本手冊以 Java 開發者為中心視角,劃分為編程規約、異常日志、單元測試、安全規約、MySQL 數據庫、工程結構六個維度,再根據內容特征,細分成若干二級子目錄。根據約束力強弱及故障敏感性, 規約依次分為強制、推薦、參考三大類。對于規約條目的延伸信息中,“說明”對內容做了適當擴展和解釋;“正例”提倡什么樣的編碼和實現方式;“反例”說明需要提防的雷區,以及真實的錯誤案例。
技術部Java開發手冊
本手冊的旨在碼出高效,碼出質量。現代軟件架構的復雜性需要協同開發完成,如何高效地協同呢?無規矩不成方圓,無規范難以協同,比如,制訂交通法規表面上是要限制行車權,實際上是保障公眾的人身安全,試想如果沒有限速,沒有紅綠燈,誰還敢上路行駛。對軟件來說,適當的規范和標準絕不是消滅代碼內容的創造性、優雅性,而是限制過度個性化,以一種普遍認可的統一方式一起做事,提升協作效率,降低溝通成本。代碼的字里行間流淌的是軟件系統的血液,質量的提升是盡可能少踩坑,杜絕踩重復的坑,切實提升系統穩定性,碼出質量。