PHP主|代碼審查的重要性

態

鑰匙要點

• 代碼審查是對計算機源代碼的系統檢查，旨在在初始開發階段找到和修復錯誤，從而提高了整體軟件質量和開發人員的技能。可以以各種形式完成，例如配對編程，非正式的演練和正式檢查。
代碼審查不僅減少了代碼中的缺陷數量，還可以增加協作，幫助團隊建設，改善開發人員之間的“兄弟情誼”，並在團隊或部門中傳播最佳實踐和技能。
• >代碼審查的最佳實踐包括知道常見錯誤並積極地與之抗爭，由具有同等技能或更高技能的人對代碼進行審查，使用清晰的里程碑審查較少的代碼，收集指標，並注意社交方面，其中尋找錯誤是好的的社交方面，還不錯。
• >本文強調不要將代碼審查視為負面或浪費時間，而要改善日常工作流程的重要性。它表明，如果您的團隊今天不使用它，請建議，因為任何類型的代碼審查總比沒有好。
>

每個開發人員都知道平庸的錯誤的痛苦。這裡是一個錯誤的屬性，那裡是一個拼寫錯誤的物業，這是一條意外重複的代碼線，您錯過了，因為您去過的咖啡供應了16小時的黑客馬拉松。即使是在開放式PHP標籤之前，您也不小心放置在此之前，因為您開始在基於地獄的Java的IDE上鍵入並重新定位光標，如果您疲倦且分心，光標可能會使您連續抓撓頭部幾個小時。如果只有一雙新鮮的眼睛可以看一下您的所作所為，那麼這些錯誤肯定很容易避免？ Wikipedia定義了代碼評論如下：

>代碼審查是計算機源代碼的系統檢查（通常稱為同行評審）。它旨在查找並解決在初始開發階段所忽略的錯誤，從而提高軟件的整體質量和開發人員的技能。評論以各種形式進行，例如配對編程，非正式的演練和正式檢查。 這個定義是這樣精確的 - 從更多的外行術語中，代碼審查只是讓別人查看您的代碼以找到您錯過的錯誤的行為。

代碼評論的類型

正如Wikipedia定義所暗示的那樣，有許多不同的方法來審查缺陷的代碼。這是其中一些的快速分解：

ot（在肩膀上）審查 - 這是小團隊通常如何處理代碼評論的方式。開發人員將編寫大量的代碼，並致電另一個開發人員查看它。另一個開發人員坐在那裡，而第一個開發人員解釋了他的所作所為，逐行。通過這種敘述，最初的開發人員注意到了他自己的一些錯誤並解決了這些錯誤，OTS開發人員注意到了其他人，並將其指出了第一個。他們還分享了有關某些問題的解決方案的意見，這些問題有時在審核過程完成後有時會重做，再次要求進行審查。如果開發人員遙遠，則可以通過屏幕共享軟件和語音聊天輕鬆完成此操作。
• >
• >工具輔助評論 - 在線和離線都有各種工具來協助代碼審核。雖然提供的各種工具詳細介紹了本文的範圍，但我們可以概括並說有付費版本（Atlassian Crucible，CodeCollaborator），免費版本（審核板），或者，如果您是獨自開發人員，則社區版本（堆棧交換代碼評論）。無論使用哪種工具，每個工具都具有幾乎相同的目的 - 它可以檢索源代碼的最新更改，並將其標記為需要審核。同行（這意味著具有同等技能或更高技能的開發人員），然後審查代碼，將其標記為審核或標記發現並提出建議的任何錯誤，並通過將其發送回原始開發人員來完成或重新引導該過程。同樣重要的是要注意，許多受歡迎的IDE都有代碼審核插件。
>
• 配對編程 - 一種非常動態的代碼審查類型，Pair編程是兩個開發人員的熱座“遊戲”，其中一位開發人員代碼和另一個開發人員坐在他旁邊。經過幾百條代碼或達到預定的里程碑後，它們會短暫休息並切換位置。現在正在編碼的人觀察到，而先前觀察到的編碼的人現在進行了編碼。這對於避免錯誤和提高整體代碼質量非常有效，但其成本是人力的兩倍。許多公司還沒有為這種風險做好準備，不幸的是，除了“兩個機器上的兩個人的工作要比一台機器上的兩個人多”，但無法思考。正是這種類型的評論產生了最佳結果：不僅避免了錯誤，而且兩個開發人員直接協作並分享有關解決方案的解決方案的想法，以解決他們遇到的問題。在不習慣的團隊中，這種評論很難實施，這也是什麼都不值得的 - 它主要適用於年輕的團隊。

順便說一句，還有一種正式的評論，由邁克爾·法根（Michael Fagan）在1970年代首次引入和研究（這種方法也稱為法甘檢查），現在有些古老，在行業中不受歡迎。正式檢查很少用於小型團隊，主要用於數百萬美元的產品，因為它在精神上非常激烈和昂貴。它包括幾個人（最多六個）與投影儀一起坐下，並一起審查代碼。每個參與者都被分配一個角色（例如讀者，主持人或審閱者），當團隊注意到任何形式的錯誤或缺陷時，一切都在很大程度上詳細介紹了- 從嚴重性到實際的代碼行，以及原因和原因和效果，即使該錯誤的預測成本也覆蓋了客戶。這是迄今為止最專業的代碼審查類型，也是對開發人員最挑剔的審查，因此並非廣泛採用。研究表明，如果使用正確的話，其他代碼審查方法也同樣有效，而無需將這麼多人綁好。

>代碼評論的最佳實踐

一旦決定實施代碼審查，可能會有一些障礙要克服。管理層可能沒有看到額外時間審查所花費的理由，或者有些程序員可能認為審查是對他們努力創建的代碼的個人攻擊。在實施代碼審查時，您可以牢記一些技巧。

1. 知道您的常見錯誤並積極與之抗爭。工作時，每個開發人員都會出現錯誤，無論他在區域中有多深，他都會犯錯。我們每個人都有這個小故障，這簡直是愚蠢的，並被別人徹底注意到。注意這些滑動。忘了過濾輸入…再次？忘了再次評論一種方法…？有了這樣的列表，開發人員可以在呼籲審查之前積極捕捉這些錯誤。這被稱為自我效應- 您知道您的代碼即將被審查，並且您不想听到審稿人說：“噢，您忘了再次過濾輸入！”您想成為搖滾明星，忍者，讓別人說“哇，這實際上是一個很好的解決方案”的人。自我效應將促使您在其他人甚至有機會查看它之前改善代碼。
2. 同行代碼審查是指具有同等技能或更高技能的人進行審查。正如常識應一樣，當初級審查高級代碼時，代碼審查無法正常工作。大三學生可能會注意到一些通常的差異，違反標準錯別字，甚至輸入過濾等錯誤，但通常無法識別出更大的問題。如果尚未出現，這通常需要由團隊中的技能來定義層次結構。
>
3. 較少的代碼和清晰的里程碑意味著更好的評論。僅在達到個人里程碑後才能對代碼進行審查，並且這些里程碑應該很小，並且應該經常發生。在面向對象的編程中，這尤其重要，但也尤其可行。完成了一個新組件，該組件擴展了一個接口，該界面連接到已經審查的適配器中？最終解決了一個特定的方法，該方法一直在困擾該部門一個星期？偉大的！組件按組件，一次將其保持在最多700-800行的代碼（註釋），這是產生絕對有效的審核過程的原因。保持您需要審查的代碼簡短，簡潔和獨立，並在想法仍然新鮮的同時盡快進行審查。請記住 - 時間很貴，所以不要花太多時間！一個小時應該足以執行此“部分審查”。
4. 收集指標。如果您使用更結構化的代碼審查（例如工具輔助或正式），但也可以在OT中進行，這會更容易。嘗試記錄您通過給定的代碼和時間單位數字數字發現的錯誤和滑倒的數量和類型。將這些數據匯總在開發人員之間，並輕鬆找出誰需要最多的幫助，誰違反了最多的標準以及您實際上通過進行代碼審查為公司節省了多少錢。很快，您將能夠實際量化代碼審查的實用性，直到這樣，公司中的每個人都會對其進行積極的興趣。這通常是實施審查中最困難的部分，因為很少有開發人員對手動統計有耐心，但是如果採用了手動統計。
注意社會方面 - 尋找蟲子是好的，還不錯！必須記住，找到錯誤是好的，不是壞事。切勿污名化或挑出犯錯的開發人員，將其定為非正式。讓人們適應代碼審查 - 幫助您的同齡人接受，而不是害怕。代碼審查不僅可以有用 - 也可能很有趣。請記住，更多的時間和更困難的任務等於更多的錯誤 - 錯誤的數量並不表示開發人員的技能！如果您是經理或團隊負責人，請確保沒有人將代碼審查視為負面或浪費時間。確保他們不認為公司被公司執行，但要改善他們的日常工作流程，無論他們在工作中如何，他們都應該保留。只要可能，請努力採用個人代碼審查方法。如果您使用的是工具，請在OT中使用它們。在接受代碼審查作為您的朋友的過程中，相互集思廣益和非正式討論的個人方法是無價的。

總結

代碼審查可能難以實施，尤其是在不習慣的老式老式團隊中。但是，一旦完成，它不僅會減少代碼中的缺陷數量，還將增加協作並幫助團隊建立，改善開發人員中的“兄弟情誼”，並傳播最佳實踐和整個團隊或部門的技能。任何類型的代碼審查總比沒有好，因此，如果您的團隊今天不使用它，請提出建議。它只能有所幫助。如果您是一個獨奏開發人員，請找到一種親切的精神來查看代碼 - 在線，社交，擴展您的開髮圈，團隊。不要將其他開發人員視為競爭，並在代碼評論中作為您的敵人，請將其他帶有代碼審查的兄弟之類的人視為完美的前線武器。 通過fotolia 圖像 經常詢問有關代碼審查的問題

>

>代碼審查在軟件開發中的重要性是什麼？

代碼審核是軟件開發中的關鍵過程，涉及檢查其他開發人員的代碼是否有錯誤，錯誤或任何潛在的改進。它有助於保持高標準的代碼質量，確保代碼可以被他人閱讀和理解，並培養團隊之間的知識共享。代碼審查還有助於在開發過程的早期捕獲和修復錯誤，從而減少了後期錯誤修復的成本和時間。

>進行代碼審查的一些最佳實踐是什麼？ >進行代碼審查的一些最佳實踐包括了解代碼的上下文，重點關注代碼的邏輯和結構，而不是編碼樣式，提供建設性的反饋，而不是急於審查過程。讓合適的人參與審核過程也很重要，通常是那些熟悉代碼庫和要審查的特定功能的人。

>

>如何使我的代碼審核更有效？為了使您的代碼審查更加有效，您應該確保您的代碼具有自我解釋，有據可查，並遵循團隊的編碼標準。您還應該將更改分解為易於審查的小塊。此外，使用代碼審核工具可以幫助簡化審核過程並提高審核過程。包括不徹底審查代碼，過多地關注編碼樣式，而不是代碼的邏輯和結構，而不是提供建設性的反饋和匆忙審查過程。不要讓合適的人參與審核過程也是一個錯誤。

>

> PHP的一些好的代碼評論工具是什麼？這些工具可以幫助自動化代碼審核過程，捕獲常見的編碼錯誤並強制執行編碼標準。

>

>我如何準備我的代碼以進行審核？

以準備您的代碼以進行審核，您應該應該確保其清潔，有據可查，並遵循團隊的編碼標準。您還應該將更改分解為易於審查的小塊。此外，您應該提供清晰簡明的更改摘要，以幫助審閱者了解您的代碼的上下文。

>

>在提供反饋時，我如何在代碼審查中提供建設性的反饋？在代碼審查中，您應該專注於代碼，而不是人。在您的評論中要具體而清晰，並提供改進的建議。在您的反饋中保持尊重和專業也很重要。

>

在代碼審查中如何處理反饋？不要親自接受反饋。將反饋視為學習和提高您的編碼技能的機會。如果您不同意評論，請與審閱者討論以了解他們的觀點。

我應該多久進行一次代碼審查？

>代碼審查的頻率可能會根據團隊和團隊而有所不同。專案.但是，通常建議定期進行代碼評論，例如每週一次或每個主要功能或錯誤修復。定期的代碼審查可以幫助捕獲和修復開發過程的早期錯誤。

>代碼評論可以改善團隊協作嗎？

是的，代碼評論可以顯著改善團隊協作。他們促進了團隊之間的知識共享，有助於在整個代碼庫中保持一致的編碼樣式，並創建集體代碼所有權的文化。代碼評論還為初級開發人員提供了向經驗豐富的團隊成員學習的機會。

以上是PHP主|代碼審查的重要性的詳細內容。更多資訊請關注PHP中文網其他相關文章！