大型項目產品功能龐大、參與人員多、周期較長,造成代碼質量和可維護性要求較高。這需要在開發階段加入定期的代碼審核機制,可通過人工code review及代碼走查工具來完成。人工Code Review耗時量大,對review人員的審查能力要求高,所以加入代碼定期自動化審查就更適合,不過缺點是代碼走查是做不到人工review的業務邏輯驗證。
C#代碼審查工具選型
對於c#代碼審查的工具比較多,常見的有FXCop, StyleCop, Sonar。不同工具的優勢及使用場景各有不同:
FxCop: 微軟的代碼分析工具,以微軟內部的.NET規范為參照,通過分析編譯好的dll文件得到錯誤信息
StyleCop: 微軟的代碼分析工具,以微軟內部的.NET規范為參照,通過代碼靜態掃描的方式分析源代碼
Sonar: 代碼質量管理平台,通過MSBuild方式分析代碼的不規范及缺陷,並將分析結果直接顯示在Web頁面上
Fxcop和styleCop屬於小工具類,安裝方便,在開發階段對代碼的規范有很好的幫助,偏開發人員使用。Sonar屬於分析平台類,需要單獨搭建服務器進行分析的結果的保存及展示,偏測試及管理人員使用。所以項目進行過程中可搭配使用,開發人員可選擇Fxcop或styleCop小工具進行代碼的自我質量把控,項目管理人員可通過Sonar來進行質量管理的分析及分配。
接下來幾篇將重點介紹Sonar的搭建和使用,對於FxCop和StyleCop使用比較簡便,可自行學習使用。
代碼規范審查之旅: