生活随笔
收集整理的這篇文章主要介紹了
为什么要评审代码?
小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.
原文以及參考譯文
Why review code?
譯文:Why review code?
最近有位朋友問我為什么做代碼評(píng)審很有價(jià)值。至少大多數(shù)硅谷科技公司都會(huì)對(duì)每一個(gè)變更進(jìn)行代碼評(píng)審,以確保至少有兩個(gè)人看過該變更。在我之前的工作中,我們選擇性地(很少地)進(jìn)行代碼評(píng)審,后來團(tuán)隊(duì)來了一位來自谷歌的新員工,他鼓勵(lì)我們?cè)u(píng)審所有代碼 - 而我們照做了。事實(shí)證明這是個(gè)很好的決定。
如果你按正確的方式進(jìn)行代碼評(píng)審,它不會(huì)讓你覺得麻煩。你和審閱你代碼的人不是對(duì)手關(guān)系,你們是一起努力構(gòu)建最好的軟件。(重點(diǎn)是不要把反饋太個(gè)人化的看待 - 即使你得改動(dòng)代碼,也不代表你有問題。獲得反饋很正常,因?yàn)樗鼛椭愠砷L(zhǎng)!)
有些公司嚴(yán)格規(guī)定了每一段代碼必須有多少人評(píng)審,以及每一段代碼必須有嚴(yán)格的歸屬者。我覺得這么做完全沒有必要,我更喜歡簡(jiǎn)單點(diǎn)的系統(tǒng),唯一的規(guī)則是每段代碼都至少有一個(gè)人評(píng)審過。事實(shí)上,你仍然得向維護(hù)你所改代碼的人提交評(píng)審意見,但不做硬性要求會(huì)更好一些。
以下是我想到的為什么代碼評(píng)審很有價(jià)值的幾大原因。這有很多了!
代碼本身。代碼評(píng)審最明顯的價(jià)值是“發(fā)現(xiàn)錯(cuò)誤”。或者如果你再深入一些,發(fā)現(xiàn)了一些作者不知道的最佳實(shí)踐或潛在規(guī)則的情況,你可以反饋給他以改進(jìn)那些具體的代碼。宏觀層面的知識(shí)分享。當(dāng)你評(píng)審別人的代碼時(shí),你其實(shí)是在學(xué)習(xí)對(duì)你有益的新技術(shù) - 反之亦然,可能別人在評(píng)審你代碼時(shí)也給你提出了更好的建議。如果你能夠?qū)W以致用,你必將成長(zhǎng)為一個(gè)工程師。微觀層面的知識(shí)分享。通過增加熟悉所有代碼的人數(shù),來緩和“公車因子(bus factor)”。(譯注:公車因子越大,代表關(guān)鍵人物流失導(dǎo)致項(xiàng)目受到影響的概率越小)趨勢(shì)分享。相應(yīng)地,代碼評(píng)審迫使你與隊(duì)友交流你們正在做的事情,這也確保了你們方向的正確性,而不至于數(shù)天或者數(shù)周之后才發(fā)現(xiàn)走在錯(cuò)誤的方向上。溝通實(shí)踐。無論是在團(tuán)隊(duì)內(nèi)部還是外部,清晰的溝通都是成功工作的最重要技能!代碼評(píng)審給了你機(jī)會(huì)去練習(xí)怎么寫作更清楚,不論是描述變更目的還是提交反饋的時(shí)候。而且幸運(yùn)的話,下次你要寫一些“非常重要”的東西時(shí),你會(huì)發(fā)現(xiàn)自己已經(jīng)準(zhǔn)備好了。歷史記錄。根據(jù)我的經(jīng)驗(yàn),如果人們知道他們寫的東西會(huì)有人看,他們會(huì)寫出更好的提交描述消息。這在回顧舊變更時(shí)非常有用!可以討論的東西。有時(shí)候你想同意某一變更,你會(huì)發(fā)現(xiàn)很難口頭描述以及表達(dá)對(duì)比如特定算法細(xì)節(jié)等的贊同。通過一段代碼進(jìn)行交流會(huì)更精確些,因?yàn)榇a往往比較明確。團(tuán)隊(duì)凝聚力。當(dāng)代碼評(píng)審變成常規(guī)活動(dòng)時(shí),你會(huì)感覺更像是一個(gè)團(tuán)隊(duì)一起工作,而不是每個(gè)人“都在自己的軌道上”。閱讀練習(xí)。練習(xí)閱讀別人的代碼,有助于你把自己的代碼寫得更具可讀性(因此,更具可維護(hù)性)。 這會(huì)讓你之后寫出更好的代碼! 如果非得做個(gè)選擇,那么原因 2、5、6 對(duì)我來說可能是最有價(jià)值的。
轉(zhuǎn)載于:https://juejin.im/post/5cd27dcdf265da03555c969d
總結(jié)
以上是生活随笔為你收集整理的为什么要评审代码?的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò),歡迎將生活随笔推薦給好友。