10 Möglichkeiten zur Verbesserung Ihres Codes, nachgewiesen durch persönliche Erfahrung

Hallo an alle in der CodeGym-Community! Heute werden wir über Codequalität sprechen. Ja, liebe Freunde. Niemand ist vollkommen. Jeder merkt irgendwann, dass der Code besser sein könnte... Aber was tun in dieser Situation? Beginnen Sie zumindest mit der Recherche zu diesem Problem. Aber Sie sind schon hier, das heißt, das Thema muss Sie interessieren, also nichts wie los. Heute beschreiben wir Möglichkeiten, wie Sie Ihren Code besser und sauberer machen können. Damit Sie sich in Zukunft nicht für Ihren aktuellen Code schämen müssen! :) All diese Methoden helfen einem Programmierer, ein guter Programmierer zu werden.

1. Wenn Sie Ihren Code verbessern möchten, lesen Sie den Code einer anderen Person

Wenn Sie Ihre Programmierkenntnisse erheblich verbessern möchten, müssen Sie ... Code lesen, der von anderen Programmierern geschrieben wurde. Glauben Sie mir oder nicht. Aber wenn Sie das Risiko eingehen, verspreche ich: Sie werden für die aufgewendete Zeit belohnt. Lesen Sie beispielsweise nicht auf medium.com darüber, wie HashMap, ArrayList, LinkedList usw. funktionieren. Lesen Sie stattdessen den Quellcode und finden Sie es selbst heraus. Hier ist eine Liste der zu lesenden Klassen:

• Die am häufigsten gestellten Fragen in Interviews beziehen sich auf HashMap. Sie können zwei Fliegen mit einer Klappe schlagen: Sie werden den Code verstehen und sich das nötige Wissen aneignen.
• Das Gleiche gilt für ArrayList. Es gibt nichts Kompliziertes, aber der Quellcode ist wirklich lesenswert und verständlich.
• String ist ein hervorragendes Beispiel. Verstehen Sie, warum es unveränderlich ist.
• AtomicInteger ist eine coole Klasse: Sie definiert atomare Operationen für Integer-Objekte.
• Danach könnten wir jede Klasse einzeln auflisten :)

Im Ernst: Sie sollten den Code von Pivotal lesen. Die Leute dort haben das gefragteste Ökosystem in der Java-Welt geschrieben. Ihr Code ist auf jeden Fall lesenswert. Ich empfehle Ihnen, mit Spring Core zu beginnen . Das Lesen unbekannten Quellcodes ist eine schwierige, aber lohnende Arbeit. :) :)

2. Befolgen Sie die Codekonventionen

Codierungskonventionen sind eine Reihe von Richtlinien, die von Entwicklungsteams erstellt werden. Sie enthalten Richtlinien für den Codierungsstil und die Techniken für jeden Aspekt des Codes. Diese Konventionen können für das gesamte Unternehmen oder für ein bestimmtes Projekt verfasst werden. Codierungskonventionen sind im Allgemeinen spezifisch für jede Programmiersprache und umfassen Dateiorganisation, Einrückungen, Kommentare, Deklarationen, Operatoren, Leerzeichen, Namenskonventionen, Programmiertechniken und -prinzipien, Programmierregeln, Best Practices für die Architektur usw. Der Hauptvorteil bestimmter Standards besteht darin, dass der Code gleich aussieht und im gleichen Stil geschrieben ist. Dies macht es besser lesbar und hilft Programmierern, den von einem anderen Programmierer geschriebenen Code zu verstehen. Wenn Codierungsstandards während des gesamten Entwicklungsprozesses konsequent befolgt und angewendet werden, In Zukunft wird es einfacher sein, Ihren Code zu warten und zu erweitern, ihn umzugestalten und Integrationskonflikte zu lösen. Codierungskonventionen sind für Programmierer aus mehreren Gründen wichtig:

• 40-80 % der Softwarekosten entfallen auf deren Wartung,
• Kaum eine Software wird während ihrer gesamten Lebensdauer von ihrem Autor gepflegt.
• Codierungskonventionen verbessern die Lesbarkeit von Quellcode, indem sie es Programmierern ermöglichen, neuen Code schneller zu verstehen.

Ehrlich gesagt bin ich ein großer Fan von Codierungsstandards. Für mich ist es sinnvoll, Zeit damit zu verbringen, darüber zu diskutieren und zu streiten, da es eine wertvolle Aktivität ist, die Ihnen in Zukunft Zeit und Mühe ersparen wird. Codekonventionen sollten regelmäßig überprüft werden. Regeln können von „erforderlich“ in „optional“ und umgekehrt geändert werden. Wenn einige davon nicht wie erwartet funktionieren, sollten sie überarbeitet oder aus den Richtlinien entfernt werden.

3. Verwenden Sie Codeüberprüfungen

Eine Codeüberprüfung ist eines der leistungsstärksten Tools zur Codeverbesserung. Warum? Denn der Code wird von den Experten angeschaut, die ihn nicht geschrieben haben. Und ein frischer Look ist sehr nützlich. Und eine Codeüberprüfung hilft oft dabei, das Schreiben von wirklich schlechtem Code zu verhindern. Ich weiß, dass Codeüberprüfungen nicht immer möglich sind, da Sie eine andere Person finden müssen, die bereit ist, eine solche durchzuführen. Das bedeutet jedoch nicht, dass Sie auf die Verwendung dieses Tools verzichten sollten. Ganz im Gegenteil: Code-Reviews sind ein Grund, Gleichgesinnte zu finden, die auch die Qualität ihres Codes verbessern müssen. Übrigens, wer wird Sie davon abhalten, sie hier auf CodeGym zu finden? An einem Ort, an dem jeder Programmierer sein möchte.

4. Schreiben Sie Unit-Tests

Meine Lieblingstechnik zur Verbesserung von Code ist definitiv das Schreiben von Unit-Tests. Je mehr davon Sie schreiben, desto besser. In der Computerprogrammierung ist Unit-Test ein Softwareentwicklungsprozess, bei dem der kleinste testbare Teil des Quellcodes, Unit genannt, einzeln und unabhängig getestet wird, um festzustellen, ob er wie erwartet funktioniert. Dies wird Ihnen helfen, Fehler in Ihren Algorithmen und/oder Ihrer Logik zu entdecken, bevor Sie Ihren Code veröffentlichen. Da Unit-Tests eine entsprechende Strukturierung Ihres Codes erfordern, muss der Code in kleinere, fokussiertere Funktionen aufgeteilt werden. Jeder ist für eine einzelne Operation an einem Datensatz verantwortlich und nicht für große Funktionen, die mehrere verschiedene Operationen ausführen ( Prinzip der Einzelverantwortung).sagt Hallo...). Der zweite Vorteil des Schreibens gut getesteten Codes besteht darin, dass Sie Codefehler vermeiden können, wenn Sie kleine Änderungen an vorhandenen Funktionen vornehmen. Wenn die Unit-Tests fehlschlagen, wird Ihnen mitgeteilt, dass etwas falsch geschrieben wurde. Auf den ersten Blick scheint die Entwicklungszeit, die für das Schreiben von Unit-Tests aufgewendet wird, ein zusätzlicher Kostenfaktor zu sein. Unit-Tests werden jedoch in Zukunft Zeit beim Debuggen sparen. Dies sollte ein schrittweiser Prozess sein. Lassen Sie uns also mit einem Lächeln weiter nach vorne gehen – wir werden Tests für jede Methode und Klasse schreiben :D

5. Verwenden Sie Tools, um die Codequalität zu verbessern

Es gibt keinen Entwickler, der noch nie einen Fehler gemacht hat. Normalerweise erkennt der Compiler Syntax- und Rechenprobleme und zeigt den Stack-Trace an. Es können jedoch dennoch einige Probleme auftauchen, die der Compiler nicht erkennt. Zum Beispiel falsch implementierte Anforderungen, falsche Algorithmen, falsch strukturierter Code oder ein anderes potenzielles Problem, das der Community aus Erfahrung bekannt ist. Die einzige Möglichkeit, solche Fehler zu erkennen, besteht darin, einen erfahreneren Entwickler zu bitten, Ihren Code zu überprüfen, oder? Aber dieser Ansatz ist kein Allheilmittel und wird nicht viel ändern. Für jeden neuen Entwickler im Team sollten Sie ein zusätzliches Paar Augen haben, die sich seinen Code ansehen. Glücklicherweise gibt es viele Tools, mit denen Sie die Qualität Ihres Codes kontrollieren können. Ich habe Checkstyle, PMD, FindBugs und SonarQube bei meiner Arbeit an verschiedenen Projekten verwendet. Und es gibt auch andere. Sie alle werden typischerweise verwendet, um die Codequalität zu analysieren und einige nützliche Berichte zu erstellen. Sehr oft werden diese Berichte von Continuous-Integration-Servern wie Jenkins veröffentlicht.

6. Schreiben Sie einfachen und unkomplizierten Code

Schreiben Sie immer einfachen, verständlichen und logischen Code. Menschen neigen dazu, komplizierten Code zu schreiben, um zu beweisen, dass sie es können. Einfacher und logischer Code funktioniert immer gut, führt zu weniger Problemen und ist besser erweiterbar. Guter Code ist die beste Dokumentation. Wenn Sie einen Kommentar hinzufügen möchten, fragen Sie sich: „Wie kann ich den Code so verbessern, dass dieser Kommentar nicht erforderlich ist?“ — Steve McConnell.

7. Lesen Sie die Dokumentation

Eine der wichtigsten Gewohnheiten guter Programmierer ist es, viel Dokumentation zu lesen. Ob Spezifikationen, JSRs, API-Dokumente, Tutorials oder etwas anderes – das Lesen der Dokumentation hilft Ihnen, eine solide Grundlage für Ihre beste Programmierung zu schaffen. Zu guter Letzt: Vergleichen Sie sich nicht mit anderen. Sich mit anderen zu vergleichen führt nur zu negativen Gefühlen und ungesundem Wettbewerb. Jeder Mensch hat seine eigenen Stärken und Schwächen. Deshalb ist es wichtig, sie zu kennen und mit ihnen zusammenzuarbeiten. Machen Sie eine Bestandsaufnahme – listen Sie Ihre Stärken auf und arbeiten Sie daran. Programmieren ist ein wahres Vergnügen: Genießen Sie es.

„Die Konstante des einen ist die Variable des anderen.“

8. Folgen Sie interessanten Bloggern

Tausende Enthusiasten auf der ganzen Welt arbeiten mit denselben Technologien und schreiben darüber. Blogs werden oft von den Programmierern selbst geschrieben und die meisten von ihnen teilen persönliche Meinungen und Erfahrungen. Durch Blogs können Sie unterschiedliche Perspektiven auf dieselbe Technologie sehen. Auf Blogs kann man sowohl gute als auch schlechte Technologien sehen. Lesen Sie mindestens Artikel im Coding Dojo Blog und CodeGym :) Folgen Sie guten Blogs und kommentieren Sie Beiträge, teilen Sie Ihre Meinung.

9. Lesen Sie Bücher über den Beruf

Nichts kann ein gutes Buch ersetzen. Ein gutes Buch vermittelt grundlegende Konzepte in einer viel einfacheren Form und lässt sich auf Dinge in der realen Welt anwenden. Ihre Autoren sind selbst großartige Programmierer. Durch das Lesen von Büchern können Sie aus den Erfahrungen anderer lernen. Ich empfehle Ihnen, Joshua Blochs „Effective Java“ zu lesen. Dieses Buch präsentiert 78 unverzichtbare Faustregeln für Programmierer: die besten funktionierenden Lösungen für die Programmierprobleme, mit denen Sie täglich konfrontiert sind. Es enthält die praktischsten und maßgeblichsten Richtlinien zum Schreiben effektiver, gut gestalteter Programme. Wenn Sie gerade erst mit Java beginnen und noch keine Programmiererfahrung haben, können Sie „Sams Teach Yourself Java 2 in 24 Hours“ lesen. Und zum Schreiben von sauberem Code gibt es ein hervorragendes Buch, „Clean Code“ von Robert Martin. Nachdem ich es gelesen habe,

10. Code! Code! Code!

Sie können kein guter Programmierer werden, indem Sie einfach ein Buch auswendig lernen. Es ist einfach, über theoretische Konzepte zu sprechen. Aber Sie können die Einschränkungen einer Sprache nur kennenlernen oder Best Practices erarbeiten, wenn Sie Code schreiben. Um ein guter Programmierer zu werden, müssen Sie daher viel Code schreiben. Wenn Sie ein Anfänger sind, beginnen Sie damit, Programme für einfache Aufgaben wie die Fibonacci-Reihe, Palindrome, das Pascal-Dreieck usw. zu schreiben. Fahren Sie dann mit größeren Aufgaben wie einem binären Suchbaum usw. fort. Wenn Sie nach einer Online-Plattform zum Üben von Java suchen Programme finden Sie unter Coding Ground . Arbeiten Sie sich durch Programmierkurse durch und ich garantiere Ihnen, dass Ihre Fähigkeiten viel besser werden. Eine weitere Möglichkeit ist die Teilnahme am Harvard CS50-Kurs, der kostenlos ist.

Fassen wir zusammen

Wer keine Fehler macht, ist derjenige, der nichts tut. Deshalb nehmen wir unsere Geduld auf und verbessern wie ein fleißiger Heuschrecke unsere Programmierfähigkeiten. Vergessen Sie dazu nicht:

• Lesen Sie den Code anderer
• Stellen Sie Codeüberprüfungen bereit und fordern Sie diese an
• Schreiben Sie Unit-Tests
• Verwenden Sie Tools, um Ihren Code zu verbessern
• Schreiben Sie einfachen und verständlichen Code
• Lesen Sie die Dokumentation, die von denen geschrieben wurde, die dazu in der Lage waren
• Folgen Sie interessanten Programmierern
• Lesen Sie Bücher über den Beruf
• Code! Code! Code!