Wenn wir gut dokumentieren, können wir den Programmierern, die unseren Code überprüfen, eine gute Möglichkeit geben, um zu verstehen, was wir getan haben und aus welchen Gründen, auf diese Weise ist die Kontinuität der Projekte besser. Außerdem hilft uns ein lesbarer Code beim Debuggen von Fehlern und ermöglicht es uns, weniger Zeit für verschiedene Faktoren aufzuwenden, als für das Erreichen unserer Ziele.
Namenskonvention
Die Namenskonvention ist äußerst wichtig, damit wir auf einen Blick Variablen von Klassen und Methoden identifizieren können .
Der erste wichtige Aspekt ist der Schreibstil der Namen. Wenn wir Variablennamen haben, müssen wir Kleinbuchstaben verwenden, und wenn wir Konstanten haben, sollten sie in Großbuchstaben geschrieben sein , sehen wir mal:
int [b] Divisor [/ b] = 5; endgültiges Doppel [b] PI [/ b] = 3,14;
Wenn wir also PI sehen, wissen wir, dass es eine Konstante ist, und wenn wir einen Divisor sehen, wissen wir, dass es eine Variable ist, und wenn wir sie manipulieren müssen, können wir dies tun, ohne zu wissen, dass wir das Programm nicht beeinflussen.
Wenn wir Namen mit mehreren Wörtern haben, müssen wir die Kamelfallmethode verwenden , dh den ersten Buchstaben der folgenden Wörter des Namens in Großbuchstaben schreiben.
Sehen wir uns die folgenden Beispiele an:
Im Bild können wir sehen, wie wir eine Klasse mit mehreren Wörtern definieren. Bei Klassen bis zum ersten Wort muss sie mit Großbuchstaben beginnen.
Raum und Idee
Wenn wir verschachtelten Code schreiben, zum Beispiel Klassen und ihre Methoden, müssen sie eingerückt sein , das heißt, sie müssen eine tabellarische Trennung haben, um ihre Verschachtelung zu kennzeichnen. Dadurch erleichtern wir die Identifizierung, welche Teile zu welchen gehören.
Wir müssen uns auch um den Abstand zwischen den verschiedenen Elementen kümmern, aus denen die Erklärungen bestehen, da ein Missbrauch zu Lesbarkeitsproblemen führen kann.
Sehen wir uns ein Beispiel für jede Sache an, zum Beispiel den Raum zwischen den Elementen. Im Bild sehen wir die richtige Form im unteren Teil, wobei jedes Element durch ein Leerzeichen getrennt ist. Im oberen Teil sehen wir jedoch in der falschen Weise, dass es keine Einheitlichkeit gibt in den Räumen.
In der nächsten Grafik sehen wir, wie ein Block mit einem guten Einzug erstellt wird. Wir können feststellen, dass jedes Element verschachtelt und durch einen Zeilenumbruch getrennt ist.
Dokumentation
Wie eingangs erwähnt, können wir in der Dokumentation unsere Kommentare innerhalb des Codes angeben. Hierzu verwenden wir die Tools, um Kommentare in Java zu schreiben. Wenn wir beispielsweise jeden Schritt, den wir ausführen, innerhalb des Codes dokumentieren möchten, können wir // verwenden, um eine Zeile zu generieren, die vom Compiler ausgelassen wird, aber in der Quelldatei gelesen werden kann.
Wenn wir zu Beginn des Unterrichts einen Block mit Kommentaren machen, verwenden wir:
/ ** / * / * ** /
Was wir in diesen Block schreiben, kann exportiert und zum Generieren von HTML-Dokumenten mit den Java-Dokumentationstools verwendet werden. Dann müssen wir jeden Fall entsprechend nutzen.
Am Ende des Tutorials haben wir eine breitere Vorstellung von Best Practices beim Ausführen von Java-Programmen, um mit der Entwicklung auf funktionaler Ebene zusammenzuarbeiten, gehen aber ein wenig über unsere Verantwortung als guter Entwickler hinaus.
