全球最大的軟件公司之一微軟擁有約140,000名員工，其中大約44％，即超過60,000名員工，是工程師。

Office、Visual Studio或Windows等幾種產(chǎn)品，都是由數(shù)千名同時(shí)在同一代碼庫上工作的工程師開發(fā)的。確保由不同子團(tuán)隊(duì)開發(fā)的代碼完美地協(xié)同工作是一件非常重要的任務(wù)。

那么你想過么，如此大的工程師規(guī)模下，微軟是如何確保代碼質(zhì)量的呢？

微軟的法寶在于：完整的代碼評(píng)審機(jī)制！

微軟代碼評(píng)審是一種被廣泛采用的工程實(shí)踐。成千上萬的工程師認(rèn)為這是一個(gè)偉大的最佳實(shí)踐。大多數(shù)高績(jī)效團(tuán)隊(duì)花費(fèi)大量時(shí)間進(jìn)行代碼評(píng)審。

那么，微軟的代碼評(píng)審究竟是一種怎樣的機(jī)制呢？今天，文摘菌就帶你來一探究竟。

調(diào)研微軟的代碼評(píng)審

在微軟代碼評(píng)審的大規(guī)模研究中，我們采訪、觀察并調(diào)查了900多名開發(fā)人員。

我們的目的是了解如何在微軟完成代碼評(píng)審。我們想知道，在進(jìn)行代碼評(píng)審的時(shí)候，開發(fā)人員面臨哪些陷阱，以及他們?yōu)榭朔@些挑戰(zhàn)而開發(fā)的最佳實(shí)踐。

您可以從微軟的代碼評(píng)審實(shí)踐中學(xué)到什么？

大多數(shù)經(jīng)驗(yàn)教訓(xùn)對(duì)于小型或大型團(tuán)隊(duì)組織都很有價(jià)值。如果您的團(tuán)隊(duì)尚未進(jìn)行代碼評(píng)審，我會(huì)向您展示該實(shí)踐的好處。如果您的團(tuán)隊(duì)已經(jīng)有了代碼評(píng)審機(jī)制，您可以將您的實(shí)踐與微軟的代碼評(píng)審實(shí)踐進(jìn)行比較。

微軟工程師多久進(jìn)行一次代碼審查？

在這項(xiàng)研究中，36％的開發(fā)人員表示他們每天進(jìn)行多次代碼評(píng)審。另有39％的開發(fā)人員表示，他們每天至少進(jìn)行一次代碼評(píng)審。 12％的人每周多次進(jìn)行代碼評(píng)審，只有13％的人表示過去一周他們沒有進(jìn)行代碼評(píng)審。

這意味著，微軟的開發(fā)人員將大量時(shí)間花在代碼評(píng)審上。因此，確保有效使用這段時(shí)間非常重要。

代碼評(píng)審提供哪些好處？

代碼評(píng)審的好處

代碼評(píng)審最重要的好處是，提高代碼質(zhì)量并找到代碼中的缺陷，另一個(gè)重要好處是知識(shí)轉(zhuǎn)移。

知識(shí)轉(zhuǎn)移意味著，審核彼此代碼的團(tuán)隊(duì)成員熟悉代碼庫的大部分內(nèi)容。但是，這也意味著代碼評(píng)審最好在團(tuán)隊(duì)內(nèi)部實(shí)施。另一個(gè)優(yōu)點(diǎn)是，新的團(tuán)隊(duì)成員和初級(jí)開發(fā)人員可以在審閱或獲得反饋的同時(shí)學(xué)習(xí)和提高他們的編碼技能。

如果開發(fā)人員在代碼評(píng)審期間討論替代解決方案，它不僅可以改善代碼庫，還可以為所有相關(guān)人員提供學(xué)習(xí)機(jī)會(huì)。因此，學(xué)習(xí)、指導(dǎo)和自我改進(jìn)是代碼評(píng)審之所以被認(rèn)為是微軟的一種有益實(shí)踐的主要原因。

開發(fā)人員通常如何進(jìn)行代碼評(píng)審？

代碼審查可以通過多種方式執(zhí)行。有時(shí)，可以很不正式， 比如一位開發(fā)人員走到另一位開發(fā)人員的桌邊一起看一些代碼。其他時(shí)候，團(tuán)隊(duì)一起審核代碼。但是，您在微軟的代碼審查中遇到的最可能的情況是，代碼評(píng)審是在借助工具的幫助下完成的。

代碼評(píng)審的工具有很多種。在微軟，團(tuán)隊(duì)可以自由選擇他們的工具。 至2016年，89％的開發(fā)人員表示使用CodeFlow代碼評(píng)審工具。稍后我將解釋更多有關(guān)此代碼評(píng)審工具的信息。從那時(shí)起，隨著Git的興起，工具領(lǐng)域發(fā)生了變化。

現(xiàn)在，讓我們考慮一個(gè)典型的代碼評(píng)審案例： 微軟的開發(fā)人員Rose剛剛完成了一個(gè)功能，現(xiàn)在想要得到她同行的反饋。

Rose如何在微軟開始代碼審查？

Rose首先要為代碼評(píng)審做準(zhǔn)備。這一步包括打開代碼評(píng)審工具，允許她預(yù)覽代碼更改。代碼評(píng)審工具可以執(zhí)行差異化對(duì)比任務(wù)，幫助羅斯確切了解她做了哪些更改。

在仔細(xì)審查了這些變化之后，她標(biāo)記了一些備注，告訴評(píng)審人她做了什么以及為什么這樣做。備注說明有助于審閱者了解代碼更改的目的和動(dòng)機(jī)。至此，代碼已準(zhǔn)備好可以發(fā)送給審閱者了。

Rose如何選擇合適的代碼審閱者？

許多經(jīng)驗(yàn)豐富的開發(fā)人員都知道應(yīng)該選誰作為代碼審閱者。然而，對(duì)于團(tuán)隊(duì)中的新人或新的工作領(lǐng)域，選擇可能會(huì)更棘手。如果Rose不知道她應(yīng)該添加誰，她會(huì)查看團(tuán)隊(duì)規(guī)定或詢問她的同事。她還可以使用代碼評(píng)審工具的推薦功能，該工具可以根據(jù)代碼庫的經(jīng)驗(yàn)和知識(shí)幫助選擇審閱者。

誰是相關(guān)審閱者？

Rose選擇她認(rèn)為可以為這段代碼貢獻(xiàn)知識(shí)的審閱者。審閱者通常是其他開發(fā)人員，但也可以包括其他利益相關(guān)者，例如開發(fā)人員工程師，UI專家或經(jīng)理。一些評(píng)審員被選是基于他們的專業(yè)知識(shí)，其他評(píng)審員被選是為了讓他們能隨了解即將發(fā)生的變化。

代碼評(píng)審的一般步驟

Rose要求她的同行反饋

一旦選中每個(gè)人，Rose就會(huì)發(fā)出代碼評(píng)審。代碼評(píng)審工具會(huì)自動(dòng)發(fā)送創(chuàng)建評(píng)審的通知到每個(gè)人。通知對(duì)象不僅包括所有審閱者，也會(huì)包括其他人員，例如相關(guān)團(tuán)隊(duì)的經(jīng)理或產(chǎn)品經(jīng)理。這些通知允許他們的信息保持同步，即使他們不需要執(zhí)行評(píng)審。

接受反饋是個(gè)迭代過程

Rose的同事們有時(shí)間就會(huì)審查代碼。每個(gè)審查者都能評(píng)注代碼，完事后把代碼發(fā)回Rose，Rose可以據(jù)此修改代碼。

審查者通常關(guān)注的點(diǎn)包括：代碼有bug嗎？代碼結(jié)構(gòu)有問題嗎？代碼有拼寫錯(cuò)誤、少個(gè)冒號(hào)之類的小毛病嗎？不是所有的評(píng)注都重要，但是有幾個(gè)小技巧可用來提升代碼評(píng)注。

Rose準(zhǔn)備新版本的代碼

Rose根據(jù)評(píng)注修改代碼。如果有的地方弄錯(cuò)了或有爭(zhēng)議，Rose可能直接去跟審查者面談，或者通過審查工具交流會(huì)更私人化一點(diǎn)。

不管怎樣，一旦Rose根據(jù)反饋完成了代碼修改，她可以發(fā)一份新版本的代碼給審查者，這份代碼叫修訂版。

若有必要，她還會(huì)收到反饋。這個(gè)循環(huán)視情況而定會(huì)持續(xù)好幾輪，一般的小代碼審查一次即可，復(fù)雜的代碼可能得審查多輪。

這樣的工作是很常見的，還可能在作者和審查者之間擦出思維的火花。

所有的審查者都批準(zhǔn)，Rose登記代碼

完事之后，審查者標(biāo)記代碼為okay，Rose終于可以把代碼補(bǔ)充到公共代碼庫了。有些團(tuán)隊(duì)會(huì)允許開發(fā)者在審查結(jié)束前就把代碼上傳到代碼庫。這種情況通常在代碼只需小修小改的時(shí)候發(fā)生，這樣可以異步審查并加速開發(fā)。

上面我說的所有步驟都是Microsoft代碼審查周期的常規(guī)操作，被所有團(tuán)隊(duì)執(zhí)行，根據(jù)團(tuán)隊(duì)不同而略有出入。

并非所有團(tuán)隊(duì)都一樣

如你所想，事情并非一成不變。Microsoft的一些團(tuán)隊(duì)會(huì)有些額外步驟或工具助力代碼審查。我會(huì)簡(jiǎn)單介紹這些額外步驟。

包含測(cè)試結(jié)果的代碼審查

可能你最不想做的事情就是，審查那些代碼審查軟件就可以審查的代碼。所以你應(yīng)該在審查之前先跑一遍測(cè)試。

一些團(tuán)隊(duì)要求做代碼審查的時(shí)候把測(cè)試結(jié)果也一起上傳。這樣可以保證人人都測(cè)試一下。

其它團(tuán)隊(duì)可能更加嚴(yán)格，每個(gè)審查者審查的時(shí)候都會(huì)觸發(fā)編譯，編譯和測(cè)試的結(jié)果都會(huì)被放在審查報(bào)告上。

涉及用戶交互界面的代碼審查

如果開發(fā)者把用戶交互界面也改了，那TA最好截個(gè)屏給別人看下。這樣審查者就省的跑代碼了，直接看圖片就行，審查者也可以方便檢查因運(yùn)行環(huán)境不同而產(chǎn)生的差異。

包含靜態(tài)分析的代碼審查

靜態(tài)分析對(duì)規(guī)范代碼樣式來說尤其有效。微軟的一些團(tuán)隊(duì)使用自動(dòng)化的靜態(tài)和動(dòng)態(tài)分析工具作為專用的機(jī)器人評(píng)審員。這些機(jī)器人評(píng)論代碼樣式和其他靜態(tài)問題。這樣就能騰出時(shí)間讓人工代碼審閱者執(zhí)行更有趣的任務(wù)。

微軟的代碼審查工具

多年來，微軟實(shí)際上的代碼評(píng)審標(biāo)準(zhǔn)之一是一個(gè)名為codeflow的內(nèi)部工具。這是一個(gè)復(fù)雜的代碼評(píng)審工具，它支持開發(fā)人員并指導(dǎo)他們完成代碼評(píng)審的所有步驟。

Codeflow幫助編寫代碼，自動(dòng)通知審閱者，并具有豐富的注釋和討論功能。

codeflow是一個(gè)相當(dāng)依賴UI的工具，很像Word或PowerPoint，如下面的截圖所示。

CodeFlow界面說明

看屏幕截圖，在左邊(A)你可以看到所有受影響的文件。

同樣在左邊，您可以看到(B)分配給評(píng)審的審核員名單以及他們的狀態(tài)(例如，已簽署或待決)?；顒?dòng)文檔顯示在編輯器(C)中。在底部，您可以看到(D)所有文檔的注釋列表。

另一方面，在活動(dòng)文檔(F)中只有一個(gè)注釋。此注釋連接到代碼的具體部分(即一行中的一個(gè)單詞)。最后，在頂部，您可以看到代碼評(píng)審的總體狀態(tài)。在這種情況下，已經(jīng)完成。之前的數(shù)字表明了不同的修正。在這次審查中，進(jìn)行了五次修訂。

評(píng)注功能

Codeflow最優(yōu)秀的特性之一是它的評(píng)論功能。代碼審閱者可以非常精確地選擇她想要評(píng)論的代碼的部分。例如，審閱者甚至可以在一行中高亮顯示一個(gè)或兩個(gè)字符，而不是突出顯示整個(gè)行。然后，審閱者可以將評(píng)論附加到該選擇。

將此注釋通知代碼作者或其他審閱者，并可以圍繞此注釋以線程的形式啟動(dòng)會(huì)話。

討論功能

這種評(píng)論功能就像在Twitter或Facebook等社交媒體平臺(tái)上發(fā)表評(píng)論。因此，Codeflow的評(píng)論體驗(yàn)非常自然，人們可以進(jìn)行豐富的對(duì)話和討論。另一個(gè)不錯(cuò)的好處是可以為這些評(píng)論線程中的每一個(gè)指定一個(gè)狀態(tài)。例如，狀態(tài)可以是“不會(huì)修復(fù)”、“已解決”或“打開”。

代碼評(píng)審修訂的比較

你也可以選擇代碼評(píng)審的兩個(gè)不同版本，并比較兩者之間的差異。這意味著您可以準(zhǔn)確地看到代碼評(píng)審作者在一個(gè)代碼評(píng)審修訂版和另一個(gè)代碼評(píng)審修訂版之間執(zhí)行了哪些更改。這方便了跟蹤審查的進(jìn)展。

代碼評(píng)審分析工具

開發(fā)人員花費(fèi)大量時(shí)間在Microsoft執(zhí)行代碼評(píng)審。為了確保這段時(shí)間得到充分利用，Microsoft擁有自己的代碼評(píng)審分析平臺(tái)。

該平臺(tái)存儲(chǔ)從代碼評(píng)審開始的所有代碼評(píng)審數(shù)據(jù)，參與代碼評(píng)審的開發(fā)人員，以及開發(fā)人員的所有評(píng)論。甚至可以追溯每次修訂的代碼更改。

這些代碼評(píng)審數(shù)據(jù)是Microsoft對(duì)代碼評(píng)審進(jìn)行多項(xiàng)實(shí)證研究的基礎(chǔ)。許多產(chǎn)品團(tuán)隊(duì)也使用它來理解他們自己的代碼評(píng)審實(shí)踐。

微軟代碼評(píng)審的未來

隨著Micorosft的參與和對(duì)GitHub的收購，改變是不可避免的。例如，在Microsoft中廣泛采用git作為源代碼管理工具，就可以看出這種變化。但是，這也意味著在微軟，以”pull request”的形式進(jìn)行的代碼評(píng)審正在上升。