Wie arbeiten Sie mit dem Code von anderen Personen zusammen?

Umgang mit Code, der von anderen Personen erstellt wurde, ist eine grundlegende Fähigkeit für einen Entwickler. Geben Sie es ein Jahr und der Code anderer Menschen könnte sogar Ihr eigenes sein.

Heute werde ich mir einige der besten Ansätze ansehen, um mit dem Code anderer Menschen umzugehen, den Legacy -Code effektiv lesen. Es ist kein einfaches Thema.

Um den Prozess zu erleichtern, rahme ich meinen Ansatz in den folgenden Bereichen:

• interagieren
• beachten Sie
• tests ausführen
• Fehler beheben, die für Neuankömmlinge ausgelegt sind
• Finden Sie verfügbare Ressourcen
• Verwenden Sie eine gute ide
• Bücher & Blogs lesen
• tragen zur Dokumentation
bei
• rücksichtsvoll

Lassen Sie uns anfangen.

Key Takeaways

• Verständnis des Code anderer Menschen ist eine grundlegende Fähigkeit für Entwickler. Um diesen Prozess zu erleichtern, sollten Entwickler mit Hauptentwicklern und anderen Teammitgliedern interagieren, sich mit der Codebasis beobachten und vertraut machen, Tests ausführen und Fehler für Neulinge beheben.
Entwickler sollten verfügbare Ressourcen nutzen, einschließlich Mailinglistenarchiven, Projektdokumentation und Versionskontrollhistorie. Eine gute IDE kann auch für das Verständnis und die Zusammenarbeit mit dem Code anderer Menschen von Vorteil sein.
durch Bücher, Blogs und andere Ressourcen von anderen lernen, kann Entwicklern dabei helfen, gemeinsame Fehler zu vermeiden und ihre Fähigkeiten zu verbessern. Der Beitrag zur Dokumentation kann auch eine wertvolle Lernerfahrung sein.
Es ist wichtig, bei der Zusammenarbeit mit dem Code anderer Personen rücksichtsvoll zu sein. Das Verständnis, dass verschiedene Entwickler unterschiedliche Ansätze haben, und das Fertigkeitsniveau kann ein respektvolleres und produktiveres Arbeitsumfeld fördern.

interagieren

Wer sind die Hauptentwickler? Wo sind sie? Sind sie direkt in Ihrem Büro erhältlich? Wenn ja, sprechen Sie mit ihnen oder senden Sie ihnen eine E -Mail. Diese Personen sollten die besten Wissensquellen über ein Projekt sein.

Sind Sie ein Remote -Arbeiter oder Freiberufler? Welche Kommunikationskanäle hat das Projekt oder Unternehmen? Sind Entwickler auf IRC, Slack, Twitter, E -Mail, Trello oder etwas anderem?

Stellen Sie sicher, dass Sie dort sind, wo sie sind. Eine Kritik, die bei Zend Framework 2 oft ausgeführt wird, ist, dass es keine aktive Gemeinschaft gibt. Dies ist nicht der Fall, da der IRC -Kanal täglich aktiv ist. Stellen Sie also sicher, dass Sie dort sind, wo sich die Entwickler und andere Teammitglieder befinden.

beachten Sie

Wenn Sie zum ersten Mal mit einem Projekt beginnen, nehmen Sie sich selbst leicht. Erwarten Sie nicht, dass Sie von Anfang an alles richtig wissen. Die Schätzungen variieren, aber ich habe von drei Wochen bis drei Monaten täglich mit Codebasen gehört, bevor ein Entwickler mit dieser Codebasis als produktiv angesehen werden kann.

Einige Leute haben die fehlgeleitete Wahrnehmung, dass Sie irgendwie einfach hineinspringen und sofort produktiv sein können. Vielleicht haben sie zu viele Hollywood -Filme wie Swordfish gesehen.

Codebasen Nehmen Sie sich Zeit, um zu lernen, wie sie mit den ideen , Vorkonzepten , Überzeugungen und von allen Entwicklern investiert sind der an dem Projekt gearbeitet hat. Angesichts der Tatsache, dass Sie neu sind, haben Sie kein Hintergrundwissen.

Hier sind 5 gute Möglichkeiten, um loszulegen:

Nehmen Sie sich Zeit, um alles zu durchlaufen
Fragen stellen
Einrichten einer Testinstallation
Versuch, die Testinstallation
• zu verwenden
Lesen Sie die Code -Kommentare und die zugehörige Dokumentation
• durch

Seien Sie nicht hart mit sich selbst, geben Sie sich die Chance, einen guten Start zu machen. Nach einer Weile werden Sie ein besseres Verständnis dafür haben, wie die Anwendung zusammengestellt wurde.

Beginnen Sie zu diesem Zeitpunkt, sich schneller zu bewegen, indem Sie Fragen anderer Entwickler und leitender Entwickler stellen. Sie hätten eine Liste von Fragen erstellt, als Sie die Codebasis durchlaufen haben.

Nehmen Sie sich Zeit, um den anderen Entwicklern nach Antworten auf Ihre Fragen und Abfragen zu fragen. Seien Sie nicht schüchtern, springen Sie hinein und erhalten Sie die Antworten und Eingaben, die Sie benötigen.

tests ausführen

Jede gute Codebasis sollte Tests haben. Wenn dies nicht der Fall ist, ist das kein gutes Zeichen. Es muss nicht heimtückisch sein - es könnte nur ein Entwickler oder ein Entwicklungsteam sein, das nie Tests implementiert hat -, aber ich würde mehr als ein wenig besorgt sein, wenn es keine gäbe.

Wenn es Tests gibt, führen Sie sie aus. Gehen sie vorbei? Ich bin auf mehr als eine Quellcodebasis gestoßen, die eine Reihe von Tests enthält, die niemand tatsächlich ausführen schien. Wurden sie auf dem neuesten Stand gehalten?

Jetzt haben Sie versucht, sie auszuführen, und lassen Sie sie gut durchlesen. Wenn sie gut geschrieben sind, sollten sie beschreiben, wie die Anwendung funktioniert, was sie erwartet und wie unterschiedliche Komponenten zusammenhängen. Nehmen Sie sich die Zeit dafür, dies zu tun, da es ziemlich aufschlussreich sein kann.

Fehler beheben, die für Neuankömmlinge ausgelegt sind

Eine weitere einfache Möglichkeit, die Fehler zu starten, besteht darin, die Fehler, die sich an Neuankömmlinge oder mehr Juniorentwickler richten, auf dem Projekt zu reparieren. Zwei gute Beispiele sind Joind.in und OwnCloud, der Bug -Tracker für Letzteres, den Sie im Screenshot unten sehen können.

Sie können sehen, dass diese Tickets klar markiert wurden. Machen Sie sich durch und beteiligen Sie sich. Diese Fehler sind nicht sehr technisch, aber Sie können sich in das Projekt befassen und Ihr Vertrauen und Wissen aufbauen.

Während Ruhm und technische Komplexität für das Ego großartig sein können, wenn die Dinge nicht funktionieren oder zu lange dauern, können sie keinen Gefallen für Ihren Stolz und Ihre Begeisterung ermöglichen. Fangen Sie klein an und lassen Sie sich den Weg ein.

Finden Sie verfügbare Ressourcen

Eines der besten Dinge, die Sie bei der Übernahme einer Codebasis oder bei einem vorhandenen Team tun können, besteht darin, so viele Ressourcen wie möglich zusammenzubringen. Nicht sicher, wonach ich suchen soll? Hier sind einige Ideen, um Ihnen den Einstieg zu erleichtern:

• Haben Sie Zugriff auf die Mailinglistenarchive?
• Gibt es ein Projekt oder ein Unternehmenswiki?
• Welche Projektdokumentation wurde zusammengestellt?
• Haben Sie den Versionskontrollhistorium durchlesen?
• Halten die Mitwirkenden aussagekräftige Commit -Nachrichten, konsequent ?

Verwenden Sie eine gute ide

Gute IDes sind ihr sprichwörtliches Gewicht in Gold wert. Ob Sie ein Ruby , python , go , Java , php oder einen anderen Sprachentwickler finden, finden Eine gute IDE, die sich entweder speziell für Ihre Sprache Ihrer Wahl gewidmet oder angemessen anpassbar gewidmet hat.

Ich schätze einige Leute, die Puristen sind und VIM oder EMACs bevorzugen, und das ist in Ordnung. Aber ich bin ein IDE -Liebhaber und meine Wahl der Wahl ist Phpstorming. Es gibt viele andere, wie Sonnenfinsternis, Textmate, Sublimetext und Visualstudio.

Sobald Sie die IDE für Sie gefunden haben, verwenden Sie die von ihnen angebotenen Funktionen. Ich werde hier speziell hier auf PHPSTORM verwiesen, aber diese Prinzipien auf Ihre Ideen Ihrer Wahl anwenden.

Beginnen Sie mit dem Code und prüfen Sie, ob er einem Standard entspricht. Dies muss kein formaler Standard sein, wie beispielsweise die PHP -PSRs. Aber lassen Sie die Entwickler einen konsistenten Stil befolgen oder ist es überall. Verwenden Sie Tools wie Messdetektor und zyklomatische Komplexitätstester, um die Qualität des Codes zu messen.

Gibt es eine Codedokumentation? In diesem Fall sollte Ihre IDE in der Lage sein, sie zu verwenden, während Sie den Code inspizieren. Verwenden Sie als Nächstes einen Schritt-durch-Debugger wie XHPROF, XDEBUG oder Zend Debugger und führen Sie die Anwendung aus, um zu sehen, wie sie funktioniert.

Was macht es? Welche Datenstrukturen erzeugt und nutzt sie? Wiederholt es Codeblöcke unnötig? Es gibt weit mehr, als ich hier abdecken kann, aber verwenden Sie die Funktionen, die Ihre IDE bietet, wenn Sie den Code durchlaufen, um Ihr Leben zu erleichtern.

lesen und lernen

Dies ist für mich persönlich ein herausragender Ausdruck. Je mehr wir lernen, desto mehr können wir wachsen und - als Ergebnis - tun. Wir sind nicht die ersten, die den Weg haben, auf dem wir uns befinden. Viele, viele, andere sind vor uns gekommen und haben viele die gleichen Fehler gemacht, die wir wahrscheinlich machen werden.

Speichern Sie sich ein bisschen Zeit und rechnen Sie ihren hart erlernten Erfahrungen, indem Sie von ihnen lernen. So viele der besseren Entwickler sind auch Autoren und Blogger.

Einer meiner persönlichen Favoriten ist Martin Fowler, der zufällig auch ein großartiges Buch zum Thema Refactoring veröffentlicht hat. Es gibt auch andere hervorragende Bücher wie Designmuster und Websites wie Sourcemaking.com.

Tun Sie sich selbst einen Gefallen und investieren weiterhin in solche Ressourcen. Es ist nicht immer einfach, aber es kann enorm lohnend sein.

tragen zur Dokumentation

bei

Dies ist eine, von der ich nicht genug mache. Es ist einfach, ein Sesselkritiker zu sein, der am Rande sitzt und eine Codebasis, einen Framework oder eine andere Art von Softwareprojekt kritisiert. Anstatt das zu tun, gehen Sie ein und beteiligen Sie sich.

Dokumentation gilt nicht für fehlgeschlagene Programmierer, Designer oder nicht-technische Personen. Einige der größten Projekte deuten darauf hin, dass der beste Ort für die Dokumentation ist.

Eines der bekanntesten Projekte, die dies tun, ist der Linux -Kernel. Wie könnte man etwas besser lernen, als es zu dokumentieren? Wenn Sie es wirklich wissen, können Sie es doch dokumentieren.

Wenn es sich also um ein Open -Source -Projekt handelt, steigen Sie ein, erfahren Sie darüber, lesen Sie den Code durch, machen Sie Notizen, während Sie weitergehen, und tragen Sie dann zur Dokumentation bei. Wenn es sich um eine interne Anwendung handelt, werden Sie als Erster mit der Dokumentation beginnen. Auch wenn für niemand anderes als Sie selbst.

Vielleicht gibt es keine Dokumentation, von denen man sprechen kann. Ein wirklich schrecklicher Ort. Aber jedes Projekt muss irgendwo beginnen. Schreiben Sie während Sie den Quellcode durcharbeiten, was Sie wissen.

Einige der besten Entwickler, die ich kenne, zum Beispiel die schöne Lorna Jane, haben auf diese Weise angefangen zu bloggen. Sie hat gebloggt, um eine Aufzeichnung dessen zu behalten, was sie lernte, was später einen der beliebtesten PHP -Blogs in der Lage hat.

rücksichtsvoll

Der letzte Punkt: Seien Sie rücksichtsvoll gegenüber den Entwicklern, deren Arbeit Sie überprüfen und auf die Sie aufbauen. Sie wissen nicht, wo sie sich in ihrer Karriere und Ausbildung befanden oder welche Beschränkungen sie für sie hatten, als sie den Code schrieben, auf dem Sie jetzt auf dem neuesten Stand sind.

Was ist mehr, auf welchem ​​Qualifikationsniveau sind Sie? Es kann für uns einfach sein, wenn wir jünger, neuer und weniger erfahren sind, andere zu beurteilen.

Wir glauben, dass wir alles wissen und dass unsere Erwartungen, Konzepte und Ansätze die wahren und korrekten Möglichkeiten sind. Aber ist das wirklich der Fall? Ich mag es zu glauben, dass wir, wenn wir reifen und ein bisschen älter werden, auch klüger werden und die breite Palette von Ansätzen für die existierende Softwareentwicklung mehr akzeptieren.

Wir müssen ihnen möglicherweise nicht zustimmen, aber sie sind nicht unbedingt falsch. Sie haben vielleicht viel zu lehren, was uns helfen kann, zu wachsen. Versuchen Sie also immer, andere Menschen und die Position, in der sie sich befanden. Das hilft doch niemanden, besonders Ihnen.

einpacken

Es gibt mehr Ladungen, die Sie tun können, um mit dem Code anderer Menschen zu einem überschaubaren Prozess zu machen. Welche Methoden, Tipps, Tricks und Tools verwenden Sie?

häufig gestellte Fragen (FAQs) zur Zusammenarbeit mit dem Code anderer Personen

Was sind einige Strategien zum Verständnis des Code eines anderen? Es gibt jedoch mehrere Strategien, mit denen Sie den Prozess erleichtern können. Versuchen Sie zunächst, ein hochrangiges Verständnis des Code zu erhalten, indem Sie alle verfügbaren Dokumentationen oder Kommentare lesen. Brechen Sie den Code als nächstes in kleinere, überschaubare Abschnitte auf und versuchen Sie, jeden Abschnitt einzeln zu verstehen. Die Verwendung eines Debuggers kann auch hilfreich sein, da Sie den Code durchlaufen und sehen können, wie es sich verhält. Zögern Sie nicht, den ursprünglichen Autor oder andere Teammitglieder um Hilfe zu bitten, wenn Sie festhalten. ist eine Technik, bei der zwei Programmierer auf einer Workstation zusammenarbeiten. Der eine, der Treiber, schreibt den Code, während der andere, der Beobachter oder Navigator, jede Codezeile überprüft, sobald er eingegeben wird. Die beiden Programmierer wechseln häufig die Rollen. Dieser Ansatz fördert ein besseres Verständnis des Code, da beide Programmierer Zweifel oder Probleme in Echtzeit diskutieren und klären können. Es hilft auch, Fehler frühzeitig zu fangen, da der Beobachter Fehler erkennen kann, die der Fahrer möglicherweise übersehen hat. Eine klare und logische Art und Weise kann anderen beim Verständnis von anderen helfen. Einige Strategien zum Organisieren von Code umfassen die Gruppierung verbundener Funktionen zusammen, die aussagekräftige Namen für Variablen und Funktionen verwenden und Kommentare zur Erläuterung komplexer Codeabschnitte abgeben. Es ist auch wichtig, etablierte Codierungskonventionen und -standards zu befolgen, da sie eine konsistente Struktur bieten, die den Code leichter zu lesen und zu verstehen. 🎜> Ein Code -Prüfer ist dafür verantwortlich, den von anderen Teammitgliedern verfassten Code zu überprüfen, um sicherzustellen, dass er den Qualitätsstandards des Teams entspricht. Dies beinhaltet die Überprüfung auf Fehler, die Sicherstellung des Codes, die festgelegten Codierungskonventionen folgen, und zu überprüfen, ob er seine beabsichtigte Funktionalität erreicht. Der Code -Reviewer gibt dem ursprünglichen Autor auch Feedback, das ihm helfen kann, seine Codierungsfähigkeiten zu verbessern. ist eine Fähigkeit, die durch die Übung verbessert werden kann. Beginnen Sie mit dem von anderen verfassten Code und verstehen Sie sie, und versuchen Sie, die von ihnen verwendeten Techniken und Strategien zu identifizieren. Nehmen Sie an Code -Bewertungen und Paarprogrammierungen teil, da diese Möglichkeiten bieten, von anderen zu lernen und unterschiedliche Perspektiven zu erhalten. Darüber hinaus kann das Studieren von Codierungsstandards und Best Practices auch dazu beitragen, Ihre Fähigkeiten zu verbessern.

Welche Tools können mich beim Verständnis und Zusammenarbeit mit dem Code anderer Personen unterstützen? Integrierte Entwicklungsumgebungen (IDEs) haben häufig Funktionen, mit denen Sie durch Code navigieren und seine Struktur verstehen können. Debugger ermöglichen es Ihnen, Code durchzusetzen und zu sehen, wie es sich verhält. Mit Tools zur Überprüfung von Code können Sie Probleme identifizieren und Feedback geben. Darüber hinaus können Dokumentationstools Ihnen helfen, den Zweck und die Funktionalität des Codes zu verstehen.

Wie kann ich schlecht dokumentierten Code umgehen? kann verwenden. Versuchen Sie zunächst, die Gesamtstruktur und Funktionalität des Code zu verstehen. Verwenden Sie einen Debugger, um den Code durchzusetzen und zu sehen, wie es sich verhält. Wenn möglich, fragen Sie den ursprünglichen Autor oder andere Teammitglieder um Klärung. Wenn Sie verstehen, sollten Sie Ihre eigenen Kommentare oder Dokumentationen hinzufügen, um zukünftigen Entwicklern zu helfen. Um den vorhandenen Code- und Codierungskonventionen zu respektieren. Beginnen Sie damit, die Codebasis und ihre Struktur zu verstehen. Stellen Sie sicher, dass Ihre Änderungen mit dem vorhandenen Code übereinstimmen und seine Funktionalität nicht stören. Testen Sie Ihre Änderungen gründlich, um sicherzustellen, dass sie keine neuen Fehler einführen. Kommunizieren Sie schließlich mit Ihrem Team und nehmen Sie an Code -Bewertungen teil, um sicherzustellen, dass Ihre Änderungen verstanden und akzeptiert werden.

Was ist die Bedeutung der Codierungsstandards in einem Team? da sie Konsistenz und Lesbarkeit über die Codebasis sicherstellen. Sie definieren, wie Code geschrieben und organisiert werden sollte, was es den Teammitgliedern erleichtert, den Code des anderen zu verstehen und mit dem Code des anderen zu arbeiten. Codierungsstandards helfen auch bei der Aufrechterhaltung der Qualität des Codes, da sie häufig Richtlinien für Fehlerbehandlungen, Sicherheit und Leistung enthalten. Die Kommunikation ist der Schlüssel, wenn Sie mit einem Team auf einer Codebasis arbeiten. Seien Sie klar und präzise, ​​wenn Sie Code besprechen, und verwenden Sie eine geeignete technische Terminologie. Nehmen Sie an Codeüberprüfungen teil und geben Sie konstruktives Feedback. Wenn Sie Probleme haben, einen Code zu verstehen, zögern Sie nicht, um Klärung zu bitten. Seien Sie außerdem offen für Feedback und verwenden Sie es, um Ihre Codierungsfähigkeiten zu verbessern.

Das obige ist der detaillierte Inhalt vonWie arbeiten Sie mit dem Code von anderen Personen zusammen?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!