中秋小長假結(jié)束，放松過后的你準(zhǔn)備好新一輪的學(xué)習(xí)了嗎？端坐小板凳開始study吧！

今天為大家?guī)淼恼n程是《代碼檢查規(guī)則背景及總體介紹》，將從代碼檢查的意義、代碼檢查場景及工具、代碼檢查規(guī)則分級三個方面來解讀代碼檢查規(guī)則。

一、代碼檢查的意義

01

提高代碼可讀性，統(tǒng)一規(guī)范，方便他人維護，長遠(yuǎn)來看符合公司內(nèi)部開源戰(zhàn)略。

02

幫助發(fā)現(xiàn)代碼缺陷，彌補人工代碼評審的疏漏，節(jié)省代碼評審的時間與成本。

03

有助于提前發(fā)現(xiàn)問題，節(jié)約時間成本，降低缺陷修復(fù)成本。

04

促進公司編碼規(guī)范的落地，在規(guī)范制定后借助工具進行準(zhǔn)入檢查。

05

提升編碼規(guī)范的可運營性，針對反饋較多的不合理規(guī)范進行調(diào)整更新。

二、代碼檢查場景及工具

1、代碼檢查場景

首先是本地研發(fā)環(huán)節(jié)，借助客戶端工具，在push發(fā)起評審之前進行檢查。

若本地代碼掃描沒有出現(xiàn)問題，就進入第二個環(huán)節(jié)：代碼準(zhǔn)入環(huán)節(jié)，即Code Review，這一環(huán)節(jié)進行增量檢查，屬于公司強制要求。

第三個環(huán)節(jié)：持續(xù)集成環(huán)節(jié)，當(dāng)代碼合入到代碼庫之后，進行全量檢查，業(yè)務(wù)線根據(jù)自身需求來配置。

2、代碼檢查工具與服務(wù)

代碼檢查的產(chǎn)品，客戶端、SCM(icode)、CI(Agile)之間具有交互性，共同構(gòu)成整個代碼檢查環(huán)節(jié)。

3、代碼檢查覆蓋范圍

在覆蓋語言方面，代碼檢查目前已經(jīng)覆蓋了包括C++，Java/android, PHP, Python, Go, JS, OC, Kotlin在內(nèi)的幾乎所有主流語言。

在檢查維度方面，代碼檢查包括編碼規(guī)范 代碼缺陷，開源框架引用安全檢查，可維護性(MI)。

4、代碼檢查速度

編碼規(guī)范：只掃描變更文件，檢查代碼變更行是否符合規(guī)范，速度較快。

缺陷檢查：需考慮文件依賴、函數(shù)調(diào)用關(guān)系、代碼上下文等，相對耗時。

三、代碼檢查規(guī)則分級

規(guī)則等級梳理

Code Review階段，所有維度掃描出的問題可以分為以下3個等級：

（1）Error：屬于需要強制解決的類型，影響代碼合入，應(yīng)視具體情況不同采取修復(fù)、臨時豁免、標(biāo)記誤報等措施及時處理；

（2）Warning：非強制解決類型，不影響代碼含入，很可能存在風(fēng)險，應(yīng)盡量修復(fù)；

（3）Advice：非強制解決類型，級別相對較低，不影響代碼含入，可以選擇性修復(fù)。

——END——

點擊進入了解更多技術(shù)信息~~

總結(jié)

以上是生活随笔為你收集整理的代码检查规则背景及总体介绍的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。