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!