Free Press

Willkommen in der wunderbaren Welt der Softwareentwicklung. Machen Sie sich bereit für eine spannende und aufregende Reise voller Code, Regeln und noch mehr Code. Und habe ich schon erwähnt, dass es Regeln gibt? Wenn Sie mit der Programmierung vertraut sind, dann ist das Konzept der Kodierungsstandards nichts Neues für Sie. Vielleicht sind Sie ein starker Befürworter dieser Richtlinien oder ein Freiheitskämpfer, der glaubt, dass Code eine Form des Ausdrucks ist. Was auch immer der Fall sein mag, es schadet nicht, sich einige der besten Praktiken anzusehen, wenn es darum geht, einen guten Code zu schreiben.
Es ist erwähnenswert, dass es zwar Kodierungsstandards gibt – aber in vielen Variationen und oft sind sie nur Richtlinien, die nicht befolgt werden müssen. Es sei denn, Sie wollen guten Code schreiben, dann sollten Sie sich wahrscheinlich an irgendeine Form von Standards halten.

Kommentare und Dokumentation schreiben

Vielleicht ist eines der ersten Dinge, die Sie als Entwickler lernen, Ihren Code zu kommentieren. Auf den ersten Blick mag es wie eine Zeitverschwendung erscheinen, nach dem Motto „Wenn sie auch Entwickler sind, können sie es verstehen“. Das stimmt zwar in manchen Fällen, aber durch die Kommentierung Ihres Codes und die Bereitstellung einer angemessenen Dokumentation können andere Entwickler den Algorithmus und die Logik, die Sie implementiert haben, nachvollziehen. Aber lassen Sie sich nicht dazu hinreißen, jede einzelne Code-Zeile zu kommentieren! Offensichtlicher Code sollte so belassen werden, wie er ist.

Schreiben Sie lesbaren und dennoch effizienten Code

Lesbarer Code ist leicht zu verstehen und nutzt dennoch optimal Platz und Zeit. Wenn Sie Code schreiben, möchten Sie ihn oft in so wenigen Zeilen wie möglich schreiben. Vielleicht können Sie eine ganze Methode oder Funktion in einer Zeile schreiben, aber das macht es nur schwerer zu lesen und zu verstehen.

Verwenden Sie Hilfsmethoden

Es ist eine gute Praxis, den Code kurz und bündig zu halten. Eine Methode sollte nur das implementieren, was sie tun muss. Wenn ein Teil Ihrer Implementierung etwas anderes tut, legen Sie es in eine separate Methode und rufen Sie diese innerhalb Ihrer Methode auf.

Wenn vermeidbar, kodieren Sie NICHT hart!

Die einzigen Dinge, die hart kodiert werden sollten, sind Konstanten. Das war’s.

Schreiben Sie Testfälle. Vergessen Sie die Randfälle nicht: 0s, leere Strings/Listen, Nullen usw.

So wissen Sie, was Ihre Methode tut, was sie braucht und was sie zurückgeben sollte. Sie wissen, wann sie funktioniert und wann sie fehlschlägt. Eine Funktion sollte immer auf Testfällen basieren, nicht auf Tests für Funktionen.

Schreiben Sie lesbaren, aber effizienten Code und halten Sie sich an die Codierungsstandards Ihres aktuellen Projekts

„DISZIPLINIERTE PERSÖNLICHE PRAKTIKEN KÖNNEN DIE FEHLEREINTRAGUNGSRATEN UM BIS ZU 75 PROZENT REDUZIEREN“

Jedes Projekt/jedes Unternehmen hat seine eigenen Codierungsstandards. Manche bevorzugen den einen Stil gegenüber dem anderen, wenn es um Dinge wie Namenskonventionen, Dateistruktur und Abstände geht.
Es gibt IDEs, in denen Sie den bevorzugten Stil einstellen können, der beim Speichern automatisch korrigiert wird. Es ist leichter zu lesen und zu verstehen, wenn alle Dateien des Projekts denselben Stil, dieselbe Namenskonvention, denselben Abstand usw. verwenden.

Benutzen Sie das Dropdown-Menü Ihrer IDE

Nicht unbedingt ein Standard, aber eine gute Praxis, die sehr hilfreich ist und Ihnen hilft, weniger Programmierfehler zu machen.

Zum Beispiel:
Wenn Sie eine Variable oder eine Methode umbenennen wollen, benutzen Sie einfach die „Refactor“-Option Ihrer IDE und sie wird alle Aufrufe dieser Methode/Variable ändern. Sie müssen sie nicht einzeln ändern, was Ihren Code anfällig für Fehler macht.
Wenn Sie Getter/Setter-Methoden für alle Ihre privaten Variablen erstellen wollen, verwenden Sie einfach „create getter/setter“ und die IDE wird die Methoden automatisch für Sie erstellen.

APIs sind praktisch

„CURRENT SOFTWARE PROJECTS SPEND ABOUT 40 TO 50 PERCENT OF THEIR EFFORT ON AVOIDABLE REWORK“

Bevor Sie eine Methode implementieren, vergewissern Sie sich, dass sie nicht für Sie verfügbar ist. Sie brauchen nicht zu programmieren, wenn Sie die Funktionalität einfach importieren können. Das macht das Leben eines Entwicklers sehr einfach.
Das berühmte Sprichwort „Erfinde das Rad nicht neu“ trifft in vielen Fällen zu. Allerdings sollten Sie immer die Auswirkungen des Imports einer Bibliothek bedenken, insbesondere wenn es sich um eine Drittanbieter-Bibliothek handelt. Abgesehen von möglichen Lizenzproblemen könnten Sie damit nur Ihre Codebasis aufblähen. Wenn Sie nur eine Methode brauchen, die Temperaturen umwandelt, müssen Sie keine Bibliothek importieren, die das und hundert andere Dinge tut.

Paarprogrammierung/Code-Review

„PEER REVIEWS CATCH 60 PERCENT OF THE DEFECTS“

Diese sind sehr hilfreich, wenn es darum geht, Ihren Code zu refaktorisieren. Andere sehen vielleicht eine bessere Implementierung, um Ihren Code zu optimieren oder ihn einfach eleganter zu gestalten. Außerdem wird so sichergestellt, dass die Entwickler sich an Standards halten und die Arbeit doppelt geprüft wird. Darüber hinaus ist es eine wunderbare Möglichkeit für Entwickler, voneinander zu lernen.

BACKUP UND SPEICHERN SIE IHRE ARBEIT OFT

Genug gesagt. Ein leerer Akku, ein Stromausfall, ein Softwarefehler, ein Brand, eine Atomkatastrophe – all das kann zu Datenverlusten führen. Durch häufiges Speichern und Sichern Ihres Codes in einem Versionskontrollsystem können Sie auf einfache Weise sicherstellen, dass Ihr Code sicher bleibt.

Codierungsstandards und bewährte Verfahren sind ein umfangreiches Thema, das sich über viele Seiten erstrecken könnte. Wenn Sie sich über Java-Codierungsstandards informieren möchten, finden Sie bei Oracle genau das. Die Anwendung dieser Standards und Praktiken variiert auch je nach Anwendung – ob Sie nun an einem großen Unternehmensprojekt arbeiten oder Ihrem kleinen Bruder bei den Hausaufgaben helfen. Basierend auf vielen Faktoren liegt es letztendlich an Ihnen, sicherzustellen, dass der von Ihnen entwickelte Code ein guter Code ist.

Haftungsausschluss: Alle in diesem Blog-Beitrag dargestellten Ansichten oder Meinungen sind ausschließlich die des Autors und repräsentieren nicht unbedingt die von Aversan Inc.