使用P3C進行專案程式碼規範管理
阿新 • • 發佈:2019-06-10
存在的問題
研發團隊的程式碼質量管理,是專案管理的重要環節之一。
專案的程式碼質量將會影響到專案的研發、測試、維護以及運營等眾多領域。
中小專案團隊在過去的程式碼質量管理中,往往存在以下幾個問題:
- 編寫者水平經驗有限。中小公司往往缺少技術專家,所以想要撰寫完整全面的程式碼規範規約比較困難。
- 文件更新維護成本高。由於程式碼規範也是隨著技術變革需要與時俱進的,所以對於中小公司來說維護成本比較大。
- 程式設計師容易疏忽。在編碼時由於專注業務邏輯的實現,而疏忽了規範的遵守。
- 程式碼質量監管費力。管理人員排查程式碼規範問題,費時費力。
阿里巴巴P3C專案
P3C專案提供了類完善的java程式碼開發手冊,並且釋出了可整合的程式碼規約自動掃描工具。
P3C專案為中小公司提供了簡單方便的程式碼質量管理工具,同時也是程式設計師培養良好程式設計習慣的得力助手。
P3C專案github地址:https://github.com/alibaba/p3c
程式碼規約掃描外掛
官方wiki:https://github.com/alibaba/p3c/wiki
P3C的應用
工作中對於P3C的應用主要體現在三方面:
- 要求開發人員學習《阿里巴巴Java開發手冊》。
- 編碼時開啟自動掃描外掛,高亮提示違反規約程式碼。
- 管理人員使用外掛掃描程式碼,監管開發中規約的執行情況。