代码检查规则背景及总体介绍
中秋小長假結束,放松過后的你準備好新一輪的學習了嗎?端坐小板凳開始study吧!
今天為大家帶來的課程是《代碼檢查規則背景及總體介紹》,將從代碼檢查的意義、代碼檢查場景及工具、代碼檢查規則分級三個方面來解讀代碼檢查規則。
一、代碼檢查的意義
01
提高代碼可讀性,統一規范,方便他人維護,長遠來看符合公司內部開源戰略。
02
幫助發現代碼缺陷,彌補人工代碼評審的疏漏,節省代碼評審的時間與成本。
03
有助于提前發現問題,節約時間成本,降低缺陷修復成本。
04
促進公司編碼規范的落地,在規范制定后借助工具進行準入檢查。
05
提升編碼規范的可運營性,針對反饋較多的不合理規范進行調整更新。
二、代碼檢查場景及工具
1、代碼檢查場景
首先是本地研發環節,借助客戶端工具,在push發起評審之前進行檢查。
若本地代碼掃描沒有出現問題,就進入第二個環節:代碼準入環節,即Code Review,這一環節進行增量檢查,屬于公司強制要求。
第三個環節:持續集成環節,當代碼合入到代碼庫之后,進行全量檢查,業務線根據自身需求來配置。
2、代碼檢查工具與服務
代碼檢查的產品,客戶端、SCM(icode)、CI(Agile)之間具有交互性,共同構成整個代碼檢查環節。
3、代碼檢查覆蓋范圍
在覆蓋語言方面,代碼檢查目前已經覆蓋了包括C++,Java/android, PHP, Python, Go, JS, OC, Kotlin在內的幾乎所有主流語言。
在檢查維度方面,代碼檢查包括編碼規范 代碼缺陷,開源框架引用安全檢查,可維護性(MI)。
4、代碼檢查速度
編碼規范:只掃描變更文件,檢查代碼變更行是否符合規范,速度較快。
缺陷檢查:需考慮文件依賴、函數調用關系、代碼上下文等,相對耗時。
三、代碼檢查規則分級
規則等級梳理
Code Review階段,所有維度掃描出的問題可以分為以下3個等級:
(1)Error:屬于需要強制解決的類型,影響代碼合入,應視具體情況不同采取修復、臨時豁免、標記誤報等措施及時處理;
(2)Warning:非強制解決類型,不影響代碼含入,很可能存在風險,應盡量修復;
(3)Advice:非強制解決類型,級別相對較低,不影響代碼含入,可以選擇性修復。
——END——
點擊進入了解更多技術信息~~
總結
以上是生活随笔為你收集整理的代码检查规则背景及总体介绍的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 银行数字化转型指南:《区域性银行数字化转
- 下一篇: 直播报名 | 超低延时直播架构解析