PHP Master | Die Bedeutung der Codeüberprüfung-PHP-Tutorial-php.cn

PHP Master | The Importance of Code Review

PHP Master | Die Bedeutung der Codeüberprüfung

Key Takeaways

Code -Überprüfung ist eine systematische Untersuchung des Computerquellcodes, mit dem in der anfänglichen Entwicklungsphase übersehene Fehler ermittelt und behoben werden sollen, wodurch die Gesamtqualität der Software und die Fähigkeiten der Entwickler verbessert wird. Es kann in verschiedenen Formen wie Paarprogrammierung, informellen Vorläufen und formellen Inspektionen durchgeführt werden.
Code -Überprüfung verringert nicht nur die Anzahl der Defekte im Code, sondern erhöht auch die Zusammenarbeit, hilft dem Team auf, verbessert die „Bruderschaft“ unter Entwicklern und verbreitet Best Practices und Fertigkeitsverbesserungen in einem Team oder Abteilungsabteilungs.
Best Practices für die Code -Überprüfung umfassen das Kennen von gemeinsamen Fehlern und das aktive Kampf gegen sie, den Code von jemandem mit gleichem oder größerem Geschick, Überprüfung weniger Code mit klaren Meilensteinen, Sammeln von Metriken und Bedenken des sozialen Aspekt , nicht schlecht.
Der Artikel betont, wie wichtig es ist, die Code -Überprüfung nicht als negativ oder Zeitverschwendung anzuzeigen, sondern als Verbesserung des alltäglichen Workflows. Wenn Ihr Team es heute nicht verwendet, schlägt dies vor, dass jede Art von Code -Überprüfung besser ist als keine.

Jeder Entwickler kennt den Schmerz banaler Fehler. Ein falsches Attribut hier, ein falsch geschriebenes Eigentum dort, eine versehentlich duplizierte Codezeile, die Sie aufgrund des 16-Stunden-Hackathons mit Kaffee getrieben haben, auf dem Sie waren. Sogar ein einfaches $ $ vor dem Öffnungs-PHP . Wenn Sie nur ein frisches Paar Augen hätten, um sich anzuschauen, was Sie getan haben - können diese Fehler leicht vermieden werden? Wikipedia definiert die Code -Überprüfung wie folgt:

Codeüberprüfung ist eine systematische Prüfung (häufig als Peer Review bezeichnet) des Computerquellcodes. Es ist beabsichtigt, Fehler zu finden und zu beheben, die in der anfänglichen Entwicklungsphase übersehen wurden, wodurch sowohl die Gesamtqualität der Software als auch die Fähigkeiten der Entwickler verbessert werden. Die Bewertungen werden in verschiedenen Formen wie Paarprogrammierung, informellen Vorgängen und formellen Inspektionen durchgeführt.

Diese Definition ist genauso präzise wie es

Die Arten von Code Review

Wie die Definition von Wikipedia deutet, gibt es viele verschiedene Möglichkeiten, den Code für Mängel zu überprüfen. Hier ist ein kurzer Zusammenbruch einiger von ihnen:

OTS (über der Schulter) Bewertung - So behandeln kleine Teams normalerweise mit Code -Bewertungen. Ein Entwickler schreibt eine anständige Menge an Code und ruft einen anderen Entwickler an, um es sich anzusehen. Der andere Entwickler sitzt dort, während der erste erklärt, was er getan hat, Linie nach Linie. Durch diese Erzählung bemerkt der ursprüngliche Entwickler einige seiner eigenen Fehler und behebt sie, und der OTS -Entwickler bemerkt andere und wies sie auf die erste hin. Sie teilen auch Meinungen zu Lösungen für bestimmte Probleme, die der ursprüngliche Entwickler nach Abschluss des Überprüfungsprozesses manchmal wiederholen wird, und fordern erneut eine Überprüfung. Dies kann auch einfach mit der Bildschirmfreigabe -Software und dem Sprachchat durchgeführt werden, wenn die Entwickler abgelegen sind.
Tool-unterstützte Überprüfung-Es gibt verschiedene Tools sowohl online als auch offline, die bei der Codeüberprüfung helfen. Während ein detaillierter Blick auf die verschiedenen angebotenen Tools außerhalb des Rahmens dieses Artikels liegt, können wir verallgemeinern und sagen, dass es bezahlte Versionen (Atlassian Crucible, Codecollaborator), kostenlose Versionen (Überprüfungsausschuss) oder, wenn Sie Solo -Entwickler sind, die Community -Version (Stack Exchange Code Review). Unabhängig vom verwendeten Tool dient jeder ziemlich gleiche Zweck - es ruft die neuesten Änderungen am Quellcode ab und markiert sie als Überprüfung. Ein Peer - das bedeutet, dass ein Entwickler gleicher oder größerer Fähigkeiten - dann den Code überprüft, ihn als überprüft oder markiert alle gefundenen Fehler, die gefunden wurden und Vorschläge machen und den Prozess entweder beenden oder wieder initiieren, indem er ihn an den Ursprungsentwickler zurücksendet. Es ist auch wichtig zu beachten, dass viele beliebte IDEs Code -Überprüfungs -Plugins haben.

Abgesehen davon gibt es auch eine formale Art der Überprüfung, die Michael Fagan in den 1970er Jahren erstmals eingeführt und erforscht wird (diese Methode ist auch als Fagan -Inspektion bezeichnet), jetzt etwas archaisch und in der Branche zugunsten. Die formelle Inspektion wird in kleinen Teams selten eingesetzt und betrifft hauptsächlich mehreren Millionen Dollar, da sie sehr geistig intensiv und teuer sind. Es umfasst mehrere Personen (bis zu sechs), die zusammen mit einem Projektor sitzen und den Code zusammen überprüfen. Jedem Teilnehmer wird eine Rolle zugewiesen (z. B. Leser, Moderator oder Rezensent) und wenn das Team Fehler oder Mängel jeglicher Art bemerkt, ist alles in hohem Maße detailliert - von Schweregrad bis zur tatsächlichen Codezeile, bis zur Ursache und Effekt, sogar die vorhergesagten Kosten dieses Fehlers, der die Kunden erreicht. Dies ist bei weitem die professionellste Art der Codeüberprüfung, aber auch die entmutigendste für Entwickler und als solche, die nicht weit verbreitet sind. Studien haben gezeigt, dass andere Methoden der Codeüberprüfung genauso effektiv sind, wenn sie richtig verwendet werden, ohne dass so viele Menschen so lange zusammengebunden werden müssen.

Best Practices für Code Review

Sobald es beschlossen wurde, die Codeüberprüfung zu implementieren, werden wahrscheinlich einige Hürden zu überwinden. Das Management sieht möglicherweise keine Begründung für die zusätzliche Zeitüberprüfung fest, oder einige Programmierer denken möglicherweise, dass eine Überprüfung ein persönlicher Angriff gegen den Code ist, für den sie hart gearbeitet haben. Hier sind einige Tipps, die Sie gut beachten können, wenn die Codeüberprüfung implementiert ist.

Kennen Sie Ihre gemeinsamen Fehler und bekämpfen Sie sie aktiv. Bei der Arbeit hat jeder Entwickler Fehler, die er üblicherweise macht, egal wie tief „in der Zone“ er ist. Jeder von uns hat diesen kleinen Fehler, der nur albern und von anderen ausgesprochen wurde. Beachten Sie diese Ausrutscher. Ich habe vergessen, die Eingabe wieder zu filtern ... wieder? Ich habe vergessen, eine Methode zu kommentieren ... wieder? Mit einer solchen Liste kann ein Entwickler diese Fehler aktiv aufsuchen, bevor sie eine Überprüfung fordert. Dies ist als Ego -Effekt bekannt - Sie wissen, dass Ihr Code kurz vorgesehen wird, und Sie möchten nicht, dass der Rezensent sagt: "AW Mann, Sie haben vergessen, Eingaben erneut zu filtern!" Sie möchten der Rockstar, der Ninja, die Person, die andere dazu bringt, zu sagen: "Wow, das ist eigentlich eine großartige Lösung." Der Ego -Effekt wird Sie dazu veranlassen, Ihren Code zu verbessern, bevor andere überhaupt die Möglichkeit haben, sich ihn anzusehen.
Peer -Code -Überprüfung bedeutet, von jemandem mit gleichen oder größeren Fähigkeiten überprüft zu werden. Wie gesunder Menschenverstand sein sollte, kann die Code -Überprüfung nicht funktionieren, wenn ein Junior den Code eines Seniors überprüft. Der Junior bemerkt möglicherweise einige übliche Diskrepanzen, Verstöße gegen Standard, Tippfehler oder sogar Fehler wie die Eingangsfilterung, kann jedoch normalerweise kein größeres Problem identifizieren. Dies erfordert häufig die Definition einer Hierarchie durch Fähigkeiten im Team, wenn man noch nicht vorhanden ist.
weniger Code mit klaren Meilensteinen bedeutet bessere Bewertungen. Der Code sollte erst nach dem Erreichen eines persönlichen Meilensteins überprüft werden, und diese Meilensteine sollten klein sein und häufig auftreten. In der objektorientierten Programmierung ist dies besonders wichtig, aber besonders besonders machbar. Beendete eine neue Komponente, die eine Schnittstelle erweitert, die zu einem bereits überprüften Adapter verbunden ist? Endlich ein Problem mit einer bestimmten Methode behoben, die die Abteilung seit einer Woche nervt? Großartig! Komponente nach Komponenten und das Aufhalten von maximal 700-800 Code-Zeilen gleichzeitig (Kommentare inklusive) erzeugt den absolut effizientesten Überprüfungsprozess. Halten Sie den Code, den Sie benötigen, kurz, prägnant und unabhängig und führen Sie die Überprüfung so schnell wie möglich nach dem Abschluss durch, während die Ideen noch frisch in Ihrem Kopf sind. Denken Sie daran - die Zeit ist teuer, also nimm auch nicht zu viel davon! Eine Stunde sollte mehr als genug sein, um diese „Abschnittsüberprüfung“ durchzuführen.
Metriken sammeln. Dies ist einfacher, wenn Sie eine strukturiertere Art von Code -Überprüfung wie Tools assistiert oder formell verwenden, aber auch in OTS durchgeführt werden können. Versuchen Sie, die Anzahl und Arten von Fehler und Ausrutschen zu beachten, die Sie durch eine bestimmte Anzahl von Code- und Zeiteinheiten finden. Zusammenlegen dieser Daten zwischen Entwicklern und problemlos herausfinden, wer die meisten Hilfe benötigt, wer gegen die meisten Standards verstößt und wie viel Geld Sie Ihrem Unternehmen tatsächlich gespart haben, indem Sie eine Codeüberprüfung durchführen. Bald können Sie die Nützlichkeit der Codeüberprüfung tatsächlich quantifizieren, und erst dann wird jeder im Unternehmen aktiv fasziniert. Dies ist normalerweise der schwierigste Teil einer Überprüfung, die implementiert werden soll, da nur wenige Entwickler die Geduld für manuelle Statistiken haben, aber es kann von Vorteil sein, wenn sie angenommen werden.
Achten Sie auf den sozialen Aspekt - das Finden von Bugs ist gut, nicht schlecht! Es ist unerlässlich, sich daran zu erinnern, dass das Finden von Bugs gut und nicht schlecht ist. Niemals einen Entwickler stigmatisieren oder ausgeht, der einen Fehler gemacht hat, machen Sie es informell. Lassen Sie sich an die Code -Überprüfung anpassen - helfen Sie Ihren Kollegen, es zu akzeptieren, nicht fürchten. Die Codeüberprüfung kann nicht nur nützlich sein, sondern auch Spaß machen. Denken Sie daran, dass mehr Zeit und schwierigere Aufgaben mehr Fehler entsprechen - die Anzahl der Fehler zeigt die Fähigkeit eines Entwicklers nicht an! Wenn Sie ein Manager oder Teamleiter sind, stellen Sie sicher, dass niemand die Code -Überprüfung als negativ oder Zeitverschwendung ansieht. Stellen Sie sicher, dass sie es nicht in der Regel vom Unternehmen erzwingen, sondern als Verbesserung des alltäglichen Workflows, den sie unabhängig von dem Unternehmen, für das sie arbeiten, aufbewahren sollten. Bemühen Sie sich nach Möglichkeit einen persönlichen Ansatz der Codeüberprüfung. Wenn Sie Tools verwenden, verwenden Sie sie auch in OTS. Der persönliche Ansatz des gegenseitigen Brainstormings und der informellen Diskussion potenzieller Lösungen für Probleme ist bei der Annahme der Code -Überprüfung als Ihr Freund von unschätzbarem Wert.

Abschließend

Die Codeüberprüfung kann unglaublich schwierig sein, insbesondere in einem Team von Oldtimern, die nicht daran gewöhnt sind. Sobald es jedoch geschafft hat, wird dies nicht nur die Anzahl der Fehler in Ihrem Code verringern, sondern auch die Zusammenarbeit erhöhen und das Teamaufbau verbessern, die „Bruderschaft“ unter den Entwicklern verbessern und Best Practices und Verbesserung der Fähigkeiten in einem gesamten Team oder Abteilungsabteilungen verbreiten. Jede Art von Codeüberprüfung ist besser als keine. Wenn Ihr Team es heute nicht verwendet, schlagen Sie dies vor. Es kann nur helfen. Wenn Sie ein Solo -Entwickler sind, finden Sie einen verwandten Spirit, um Code zu überprüfen - online zu gehen, Kontakte zu knüpfen, Ihre Entwicklungskreise zu erweitern, sich zusammenzusetzen. Sehen Sie sich andere Entwickler nicht als Wettbewerb und bei Code Review als Ihren Feind an. Sehen Sie sich andere wie Waffenbrüder mit Code -Bewertung als Ihre Waffe an der Front perfekt an. Bild über Fotolien

häufig gestellte Fragen zu Code Review

Was ist die Bedeutung der Code -Überprüfung in der Softwareentwicklung? Es hilft, einen hohen Codequalitätsstandard beizubehalten, stellt sicher, dass der Code von anderen lesbar und verständlich ist und den Wissensaustausch im Team fördert. Die Code -Überprüfung hilft auch dabei, Fehler zu Beginn des Entwicklungsprozesses zu fangen und zu beheben und die Kosten und die Zeit der Fehlerbehebungen in den späteren Stadien zu verringern. > Einige Best Practices für die Durchführung einer Codeüberprüfung umfassen das Verständnis des Kontextes des Codes, der Schwerpunkt auf der Logik und Struktur des Code, anstatt den Codierungsstil, ein konstruktives Feedback zu geben und den Überprüfungsprozess nicht zu überstürmen. Es ist auch wichtig, die richtigen Personen in den Überprüfungsprozess einzubeziehen, in der Regel diejenigen, die mit der Codebasis und der zu überprüften Funktionen vertraut sind. Um Ihre Code-Überprüfung effektiver zu gestalten, sollten Sie sicherstellen, dass Ihr Code selbsterklärend, gut dokumentiert ist und den Codierungsstandards Ihres Teams folgt. Sie sollten auch Ihre Änderungen in kleine, überschaubare Brocken aufteilen, die leichter zu überprüfen sind. Darüber hinaus kann die Verwendung eines Code -Überprüfungs -Tools dazu beitragen, den Überprüfungsprozess zu optimieren und effizienter zu gestalten. Geben Sie den Code nicht gründlich ein, konzentrieren Sie sich zu sehr auf den Codierungsstil und nicht auf die Logik und Struktur des Codes, ohne konstruktives Feedback und stürzen Sie den Überprüfungsprozess. Es ist auch ein Fehler, nicht die richtigen Personen in den Überprüfungsprozess einzubeziehen.

Was sind einige gute Tools für Code -Review -Tools für PHP? Diese Tools können dazu beitragen, den Code -Überprüfungsprozess zu automatisieren, gemeinsame Codierungsfehler zu fangen und die Codierungsstandards durchzusetzen.

Wie kann ich meinen Code für die Überprüfung vorbereiten? Stellen Sie sicher, dass es sauber, gut dokumentiert ist und den Codierungsstandards Ihres Teams folgt. Sie sollten auch Ihre Änderungen in kleine, überschaubare Brocken aufteilen, die leichter zu überprüfen sind. Darüber hinaus sollten Sie eine klare und kurze Zusammenfassung Ihrer Änderungen vorlegen, um dem Rezensenten den Kontext Ihres Codes zu verstehen. In einer Code -Überprüfung sollten Sie sich auf den Code konzentrieren, nicht auf die Person. Seien Sie in Ihren Kommentaren spezifisch und klar und geben Sie Verbesserungsvorschläge vor. Es ist auch wichtig, in Ihrem Feedback respektvoll und professionell zu sein. Nehmen Sie das Feedback nicht persönlich. Betrachten Sie das Feedback als Gelegenheit, Ihre Codierungsfähigkeiten zu lernen und zu verbessern. Wenn Sie mit einem Kommentar nicht einverstanden sind, besprechen Sie ihn mit dem Rezensent, um ihre Perspektive zu verstehen.

Wie oft sollte ich Code -Bewertungen durchführen? Projekt. Es wird jedoch allgemein empfohlen, regelmäßig Codeüberprüfungen durchzuführen, z. B. einmal pro Woche oder für jede größere Funktion oder jeden Fehlerfix. Regelmäßige Codeüberprüfungen können bei der Entwicklung und Behebung von Fehler zu Beginn des Entwicklungsprozesses helfen. Sie fördern den Wissensaustausch des Teams, tragen dazu bei, einen konsistenten Codierungsstil in der gesamten Codebasis aufrechtzuerhalten und eine Kultur des kollektiven Code -Besitzes zu erstellen. Code -Bewertungen bieten Junior -Entwicklern auch die Möglichkeit, von erfahreneren Teammitgliedern zu lernen.

Das obige ist der detaillierte Inhalt vonPHP Master | Die Bedeutung der Codeüberprüfung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!