現代軟件行業的高速發展對開發者的綜合素質要求越來越高,因為不僅是編程知識點,其它維度的知識點也會影響到軟件的最終交付質量。比如:數據庫的表結構和索引設計缺陷可能帶來軟件上的架構缺陷或性能風險;工程結構混亂導致后續維護艱難;沒有鑒權的漏洞代碼易被黑客攻擊等等。所以本手冊以 Java 開發者為中心視角,劃分為編程規約、異常日志、單元測試、安全規約、MySQL 數據庫、工程結構、設計規約七個維度,再根據內容特征,細分成若干二級子目錄。根據約束力強弱及故障敏感性,規約依次分為強制、推薦、參考三大類。對于規約條目的延伸信息中,“說明”對規約做了適當擴展和解釋;“正例”提倡什么樣的編碼和實現方式;“反例”說明需要提防的雷區,以及真實的錯誤案例。