代碼評(píng)審每個(gè)人都要參加嘛？通過(guò)代碼評(píng)審，團(tuán)隊(duì)中的每個(gè)人都有機(jī)會(huì)相互理解的代碼內(nèi)容，有助于促進(jìn)跨庫(kù)和整個(gè)團(tuán)隊(duì)的知識(shí)共享，讓任何團(tuán)隊(duì)成員都可以接手并繼續(xù)推動(dòng)整個(gè)項(xiàng)目的演進(jìn)。如何解決代碼和文檔不一致的問(wèn)題？

代碼評(píng)審每個(gè)人都要參加嘛？

通過(guò)代碼評(píng)審，團(tuán)隊(duì)中的每個(gè)人都有機(jī)會(huì)相互理解的代碼內(nèi)容，有助于促進(jìn)跨庫(kù)和整個(gè)團(tuán)隊(duì)的知識(shí)共享，讓任何團(tuán)隊(duì)成員都可以接手并繼續(xù)推動(dòng)整個(gè)項(xiàng)目的演進(jìn)。

如何解決代碼和文檔不一致的問(wèn)題？

這里的文檔不是指Javadoc、Doxygen等生成的API文檔。對(duì)于一個(gè)負(fù)責(zé)任的團(tuán)隊(duì)來(lái)說(shuō)，這類文檔的更新可以保證代碼同時(shí)更新。

首先看文件是干什么用的。重要性高，必須改變:如日本外包軟件。這是以后保養(yǎng)的重要參考。一般的代碼不一致是由于開(kāi)發(fā)人員沒(méi)有嚴(yán)格按照文檔進(jìn)行編碼。或者有了新的需求變更，代碼先行，沒(méi)有回頭修改階段。應(yīng)該記錄在案。

這是一種不合理的操作模式。

如何避免？

專門指派的維護(hù)人員，通常是設(shè)計(jì)師、高級(jí)工程師、PM，在變更發(fā)生時(shí)及時(shí)做出修正。另外，加大評(píng)價(jià)力度。設(shè)計(jì)評(píng)審，代碼評(píng)審。防止偏差

如何解決已經(jīng)發(fā)生的偏差？

什么？;什么是錯(cuò)的？;的錯(cuò)誤，并糾正和警告造成偏差的人，這是沒(méi)有辦法的。

Code Review常見(jiàn)的5個(gè)錯(cuò)誤模式？

在代碼評(píng)審時(shí)，每個(gè)人都會(huì)關(guān)心最佳實(shí)踐，但最差的實(shí)踐有時(shí)可能更有啟發(fā)性。

代碼審查對(duì)于研發(fā)是必不可少的。ampd團(tuán)隊(duì)，但它并不總是正確的。本文指出了所有開(kāi)發(fā)人員在提交代碼審查或拉取請(qǐng)求時(shí)可能會(huì)遇到的一些常見(jiàn)錯(cuò)誤模式，并總結(jié)了這些錯(cuò)誤模式:

錯(cuò)誤模式:查找故障

想象一下下面的場(chǎng)景。代碼編寫者花費(fèi)數(shù)小時(shí)甚至數(shù)天來(lái)創(chuàng)造他們認(rèn)為最有效的解決方案。他們考慮了各種設(shè)計(jì)方案，并選擇了看起來(lái)最相關(guān)的方案。他們考慮了現(xiàn)有應(yīng)用程序的架構(gòu)，并在適當(dāng)?shù)牡胤竭M(jìn)行了修改。然后，他們以拉請(qǐng)求的形式提交了他們的解決方案，或者開(kāi)始了代碼審查的過(guò)程，他們收到的專家反饋是:

你應(yīng)該使用標(biāo)簽，而不是空格。我不 我不喜歡大括號(hào)在這部分的位置。文檔末尾沒(méi)有空行。你的詞庫(kù)是大寫的，所以你應(yīng)該大寫句子。盡管新代碼與現(xiàn)有代碼的風(fēng)格保持一致很重要，但這些事情幾乎不需要審計(jì)人員來(lái)完成。好的。人工審核員的成本很高，他們可以做計(jì)算機(jī)能做的事情。;t .檢查是否符合風(fēng)格標(biāo)準(zhǔn)是計(jì)算機(jī)很容易完成的事情，分散了代碼審查的真正目的。

如果開(kāi)發(fā)人員在代碼評(píng)審過(guò)程中看到很多這樣的注釋，說(shuō)明團(tuán)隊(duì)要么沒(méi)有風(fēng)格指南，要么有風(fēng)格指南，但是風(fēng)格檢查還沒(méi)有自動(dòng)化。解決方案是使用checkstyle之類的工具來(lái)確保遵循了樣式指南，或者使用sonarqube識(shí)別常見(jiàn)的質(zhì)量和安全問(wèn)題。持續(xù)集成環(huán)境可以做到這一點(diǎn)，而不是依賴人類審計(jì)員來(lái)警告這樣的問(wèn)題。

有時(shí)候，如果沒(méi)有代碼指南，或者內(nèi)部代碼風(fēng)格隨時(shí)間變化，不同的部分有不同的風(fēng)格，那么這個(gè)自動(dòng)檢查可能會(huì)比較困難。在這種情況下，有一些方法可以應(yīng)用自動(dòng)檢查。例如，一個(gè)團(tuán)隊(duì)可能同意提交一份報(bào)告，應(yīng)用商定的代碼風(fēng)格，不包含其他更改?；蛘咭粋€(gè)團(tuán)隊(duì)可以約定，當(dāng)一個(gè)文件由于bug或者函數(shù)而被更改時(shí)，該文件也將被更新為新的樣式，并且自動(dòng)化工具可以被配置為只檢查被更改的文件。

如果一個(gè)團(tuán)隊(duì)有多種代碼風(fēng)格，并且它可以 不要自動(dòng)檢查款式，很容易落入下一個(gè)陷阱。

錯(cuò)誤模式:反饋不一致

每一個(gè)被邀請(qǐng)?jiān)u審代碼的開(kāi)發(fā)人員都應(yīng)該邀請(qǐng)至少一個(gè)或更多的意見(jiàn)。每個(gè)人都可以同時(shí)持有不止一種觀點(diǎn)。有時(shí)，代碼審查可能會(huì)陷入審查者之間關(guān)于不同方法的爭(zhēng)論中，例如使用streams或classic for。循環(huán)是最好的。如果團(tuán)隊(duì)成員對(duì)同一段代碼有不同意見(jiàn)，開(kāi)發(fā)人員該如何修改，結(jié)束評(píng)審，將代碼推向生產(chǎn)？

甚至一個(gè)評(píng)論家 的想法很容易改變，無(wú)論是在一次審查中，還是在一系列審查中。在一次審查中，審查者可能會(huì)敦促作者使用O(1)讀取操作的數(shù)據(jù)結(jié)構(gòu)，在下一次審查中，審查者可能會(huì)問(wèn)為什么不同。用戶會(huì)有幾種數(shù)據(jù)結(jié)構(gòu)，建議用單一結(jié)構(gòu)的線性搜索來(lái)簡(jiǎn)化代碼。

當(dāng)一個(gè)團(tuán)隊(duì)沒(méi)有。;不清楚它的最佳實(shí)踐是什么樣的，當(dāng)團(tuán)隊(duì)沒(méi)有 如果不知道它的優(yōu)先級(jí)是什么，就會(huì)出現(xiàn)這種情況:

代碼應(yīng)該向更現(xiàn)代的Java風(fēng)格發(fā)展嗎？或者更重要的是代碼一致性，所以繼續(xù)到處使用經(jīng)典構(gòu)造？讀取系統(tǒng)所有部分的O(1)數(shù)據(jù)結(jié)構(gòu)很重要嗎？還是O(n)的某些部分可以接受？幾乎處處所有的設(shè)計(jì)問(wèn)題都可以根據(jù)情況來(lái)回答。為了更好地了解答案，開(kāi)發(fā)人員需要了解他們的應(yīng)用程序和團(tuán)隊(duì)的優(yōu)先級(jí)。

錯(cuò)誤模式:最后一分鐘設(shè)計(jì)變更

開(kāi)發(fā)人員在代碼評(píng)審過(guò)程中最令人泄氣的反饋是，當(dāng)評(píng)審人員從根本上不同意方案的設(shè)計(jì)或架構(gòu)，強(qiáng)行完全重寫代碼時(shí)，他們要么通過(guò)一系列評(píng)審一步步完成(見(jiàn)下一節(jié))，要么粗暴地拒絕代碼，讓作者重新打開(kāi)。開(kāi)始吧。

代碼審查不是審查設(shè)計(jì)的合適時(shí)機(jī)。如果團(tuán)隊(duì)遵循經(jīng)典的網(wǎng)關(guān)代碼審查，那么在最后一步將代碼展示給另一個(gè)開(kāi)發(fā)人員之前，代碼應(yīng)該工作，并且所有的測(cè)試都應(yīng)該通過(guò)。此時(shí)此刻，事實(shí)上，幾個(gè)小時(shí)，幾天，甚至幾周(雖然我真的希望它 不是幾周；代碼評(píng)審應(yīng)該是小菜一碟，但這是另一個(gè)話題)努力都花在評(píng)審的代碼上了。代碼評(píng)審中指出底層設(shè)計(jì)是錯(cuò)誤的。這是對(duì)每個(gè)人的浪費(fèi)。;是時(shí)候了。

代碼評(píng)審可以作為設(shè)計(jì)評(píng)審，但是如果這是代碼評(píng)審的意圖，那么評(píng)審就應(yīng)該在實(shí)現(xiàn)之初進(jìn)行。然后，在開(kāi)發(fā)人員走得太遠(yuǎn)之前，他們可以概述他們的想法，也許會(huì)有一些存根類和方法，以及一些對(duì)名稱和步驟有意義的測(cè)試，也許還可以提交一些文字或圖表，這樣團(tuán)隊(duì)成員就可以對(duì)要采用的方法給出反饋。

如果團(tuán)隊(duì)成員在網(wǎng)關(guān)評(píng)審期間(即，當(dāng)代碼完成并運(yùn)行時(shí))發(fā)現(xiàn)了真正的演示設(shè)計(jì)問(wèn)題，團(tuán)隊(duì)?wèi)?yīng)該更新過(guò)程以更早地定位這些問(wèn)題。這可能意味著進(jìn)行其他類型的回顧，如前一段中建議的回顧、白板上的想法和配對(duì)。程序，或者與技術(shù)主管討論建議的解決方案。在最終的代碼評(píng)審中發(fā)現(xiàn)設(shè)計(jì)問(wèn)題，是對(duì)開(kāi)發(fā)時(shí)間的浪費(fèi)，對(duì)代碼作者的打擊也很大。

錯(cuò)誤模式:乒乓球評(píng)論

在理想的情況下，作者會(huì)提交代碼供評(píng)審，評(píng)審人員會(huì)提出一些明確的解決方案。作者會(huì)建議修改并重新提交代碼，代碼會(huì)在評(píng)審后被推送。但是如果這樣的事情經(jīng)常發(fā)生，誰(shuí)又能告訴Code Revi呢？Ew s流程有道理？

在現(xiàn)實(shí)生活中，經(jīng)常會(huì)發(fā)生這樣的事情:

代碼審查開(kāi)始。有評(píng)論者提出了幾個(gè)建議:有的小而易，有的不修邊幅，沒(méi)有明顯的解決方案，有的比較復(fù)雜。作者做了一些改動(dòng):至少是簡(jiǎn)單的改動(dòng)，或者幾處改動(dòng)，為了讓審稿人滿意。作者可以向?qū)忛喺咛釂?wèn)以澄清一些事情，或者作者可以做出評(píng)論來(lái)解釋為什么沒(méi)有做出具體的更改。評(píng)審人員回來(lái)后，他們接受一些更新，對(duì)其他修訂提出進(jìn)一步的意見(jiàn)，找出他們不知道的地方。;不喜歡，回答問(wèn)題，并與其他評(píng)論者討論或作者對(duì)他們的觀點(diǎn)提出了質(zhì)疑。代碼編寫人員進(jìn)行更多的修改，添加更多的注釋和問(wèn)題，等等。審稿人檢查修改，提出更多的意見(jiàn)和建議，等等。重復(fù)第5步和第6步，也許是永遠(yuǎn)重復(fù)。在這個(gè)過(guò)程中，理論上，修改和注釋應(yīng)該向零遞減，直到代碼準(zhǔn)備好。最郁悶的是每次迭代都會(huì)帶來(lái)至少和已經(jīng)結(jié)束的老問(wèn)題一樣多的新問(wèn)題。在這種情況下，團(tuán)隊(duì)進(jìn)入了代碼審查的無(wú)限循環(huán)。這有許多原因:

如果評(píng)審者很挑剔，并且評(píng)審者給出的反饋不一致，就會(huì)出現(xiàn)這種情況。對(duì)于陷入這些習(xí)慣的評(píng)論者來(lái)說(shuō)，有無(wú)限多的問(wèn)題需要發(fā)現(xiàn)，有無(wú)限多的觀點(diǎn)需要提出。當(dāng)沒(méi)有明確的審稿目的，或者審稿時(shí)沒(méi)有遵循的準(zhǔn)則時(shí)，就會(huì)之所以會(huì)出現(xiàn)這種情況，是因?yàn)檫@樣一來(lái)，每一個(gè)審核者都會(huì)覺(jué)得每一個(gè)可能出現(xiàn)的問(wèn)題都必須找出來(lái)。它發(fā)生在不清楚什么是審查者 的注釋對(duì)代碼作者的要求。是不是每一條評(píng)論都意味著必須修改？所有的問(wèn)題都暗含代碼嗎？沒(méi)有自證，需要改進(jìn)？還是有些評(píng)論只是為了下次教育代碼編寫人員，提問(wèn)只是為了幫助評(píng)審人員理解和學(xué)習(xí)？評(píng)論應(yīng)該理解為屏蔽或者不屏蔽。如果評(píng)審人員決定需要修改代碼，他們需要清楚地說(shuō)明代碼作者應(yīng)該做什么。姚行動(dòng)了。

了解誰(shuí)決定審計(jì)是否完成也很重要。這可以通過(guò)檢查任務(wù)列表上的項(xiàng)目來(lái)實(shí)現(xiàn)，或者可以由授權(quán)足夠好的個(gè)人來(lái)完成。它通常需要一個(gè)能打破僵局，解決分歧的人。這個(gè)人可能是高級(jí)開(kāi)發(fā)人員、領(lǐng)導(dǎo)或架構(gòu)師。老師，甚至是團(tuán)隊(duì)中的代碼編寫人員，因?yàn)樵趫F(tuán)隊(duì)中，他們之間有著高度的信任。然而，在某些時(shí)候，需要有人說(shuō)審查結(jié)束了或者當(dāng)這些步驟完成時(shí)，審查就結(jié)束了。

錯(cuò)誤模式:幽靈審查

在這里我承認(rèn)我最容易犯一個(gè)異常:重影。無(wú)論我是評(píng)審人員還是代碼作者，代碼評(píng)審總會(huì)有一個(gè)點(diǎn)(有時(shí)是在開(kāi)始！)，在審核過(guò)程中，我沒(méi)有 完全沒(méi)有反應(yīng)。也許有一個(gè)重要或有趣的功能需要我檢查，所以我決定把它留到更好的時(shí)候，那時(shí)我可以真正好好看看。也可能是復(fù)習(xí)量大，想留出足夠的時(shí)間?；蛘呶揖褪亲髡?。經(jīng)過(guò)20次迭代，我就可以 t面讀和回復(fù)評(píng)論，所以我決定等等。等我腦袋準(zhǔn)備好了再回來(lái)。

聽(tīng)起來(lái)熟悉嗎？

不管什么原因，有時(shí)人們不。;在審核過(guò)程中，不要做出任何回應(yīng)。這可能意味著在這個(gè)人讀完代碼之前，評(píng)審就已經(jīng)死了。這是浪費(fèi)。即使有人投入時(shí)間來(lái)創(chuàng)建一個(gè)資產(chǎn)(新代碼)，它也沒(méi)有。;投產(chǎn)前沒(méi)有增加。增加價(jià)值。事實(shí)上，當(dāng)它越來(lái)越落后于其他代碼庫(kù)時(shí)，它很可能已經(jīng)腐爛了。

有幾個(gè)因素會(huì)導(dǎo)致幽靈審查。巨大的代碼審查量是一個(gè)因素，因?yàn)檎l(shuí)愿意去檢查幾十或幾百個(gè)修改過(guò)的文件呢？不重視代碼審查是另一個(gè)因素，因?yàn)椴恢匾暣a審查是真正的工作或交付結(jié)果。一部分原因是困難或令人沮喪的代碼審查經(jīng)歷是另一個(gè)主要因素。沒(méi)有人愿意停止編碼(開(kāi)發(fā)人員通常喜歡的東西)，參與一項(xiàng)耗費(fèi)時(shí)間、摧毀靈魂的活動(dòng)。

以下是解決幽靈審查的建議:

確保代碼審查規(guī)模較小。每個(gè)團(tuán)隊(duì)都必須制定自己的定義，但這需要幾個(gè)小時(shí)或幾天的審查，而不是幾周。確保代碼評(píng)審的目的是明確的，評(píng)審者應(yīng)該尋找什么是清楚的。當(dāng)范圍是It 當(dāng)您發(fā)現(xiàn)代碼中可能存在的任何問(wèn)題時(shí)，很難激勵(lì)自己去做一些事情。在開(kāi)發(fā)過(guò)程中留出時(shí)間進(jìn)行代碼審查。最后一點(diǎn)可能需要團(tuán)隊(duì)紀(jì)律，或者團(tuán)隊(duì)可能希望采用，例如，目標(biāo)或用于確定開(kāi)發(fā)人員的任何東西。獎(jiǎng)勵(lì)良好代碼評(píng)審行為和鼓勵(lì)允許時(shí)間的生產(chǎn)力機(jī)制。

你的團(tuán)隊(duì)能做什么？

對(duì)于R ampamp團(tuán)隊(duì)，專注于創(chuàng)建一個(gè)有效的代碼評(píng)審過(guò)程。我已經(jīng)在我的博客上寫了這個(gè)，但是我想在這里分享這個(gè)過(guò)程的一部分:

代碼評(píng)審需要考慮很多事情。如果開(kāi)發(fā)人員擔(dān)心每一次代碼評(píng)審中的所有事情，那么任何代碼都幾乎不可能通過(guò)評(píng)審過(guò)程。實(shí)現(xiàn)一個(gè)適合所有人的代碼評(píng)審。過(guò)程中，最好的辦法是考慮以下問(wèn)題。

團(tuán)隊(duì)為什么要做評(píng)審？當(dāng)有一個(gè)明確的目的，考官 的工作會(huì)更容易，代碼作者也會(huì)減少審查過(guò)程中令人不快的意外。團(tuán)隊(duì)成員在尋找什么？當(dāng)有目的時(shí)，開(kāi)發(fā)人員可以在審查代碼時(shí)創(chuàng)建一組更有針對(duì)性的檢查內(nèi)容。誰(shuí)將參加？用什么？誰(shuí)來(lái)做評(píng)審，誰(shuí)來(lái)負(fù)責(zé)解決意見(jiàn)，誰(shuí)來(lái)最終決定代碼是否合格？團(tuán)隊(duì)何時(shí)進(jìn)行評(píng)審，評(píng)審何時(shí)完成？審計(jì)可以在開(kāi)發(fā)人員處理代碼時(shí)或者在過(guò)程結(jié)束時(shí)反復(fù)進(jìn)行。沒(méi)有明確的指導(dǎo)，審查可能會(huì)繼續(xù)下去。走下去，如果沒(méi)有明確的指導(dǎo)，代碼什么時(shí)候才能最終進(jìn)行。團(tuán)隊(duì)在哪里進(jìn)行評(píng)審？代碼審查不會(huì)。;不需要特殊的工具，所以審查可能就像作者在他的辦公桌前向他的同事展示他們的代碼一樣簡(jiǎn)單。一旦你回答了這些問(wèn)題，你的小組團(tuán)隊(duì)?wèi)?yīng)該能夠創(chuàng)建一個(gè)運(yùn)行良好的代碼審查過(guò)程。記住:代碼評(píng)審的目的應(yīng)該是把代碼投入生產(chǎn)，而不是證明開(kāi)發(fā)人員有多聰明。

結(jié)論

通過(guò)建立一個(gè)清晰的代碼評(píng)審過(guò)程，可以消除或者至少減輕代碼評(píng)審的錯(cuò)誤模式。許多團(tuán)隊(duì)認(rèn)為他們應(yīng)該進(jìn)行代碼審查，但是他們沒(méi)有明確的指導(dǎo)方針。他們?yōu)槭裁匆M(jìn)行代碼審查？Review.

不同的團(tuán)隊(duì)需要不同類型的代碼評(píng)審，正如不同的應(yīng)用程序有不同的業(yè)務(wù)和性能需求。第一步是找出團(tuán)隊(duì)為什么需要評(píng)審代碼，然后團(tuán)隊(duì)可以開(kāi)始:

自動(dòng)化的簡(jiǎn)單檢查(例如，檢查代碼風(fēng)格，識(shí)別常見(jiàn)的錯(cuò)誤，以及發(fā)現(xiàn)安全問(wèn)題)。對(duì)評(píng)審的時(shí)間、內(nèi)容和評(píng)審后由誰(shuí)來(lái)決定制定明確的指導(dǎo)方針，將代碼評(píng)審作為開(kāi)發(fā)過(guò)程中的重點(diǎn)工作內(nèi)容來(lái)抓。為什么要進(jìn)行代碼評(píng)審，這將有助于團(tuán)隊(duì)創(chuàng)建代碼評(píng)審過(guò)程的最佳實(shí)踐，從而更容易避免代碼評(píng)審的錯(cuò)誤模式。