Einen funktionierenden Code zu schreiben ist nie genug. Sie müssen es wartbar und verständlich schreiben. Zu diesem Zweck hat Robert Cecil Martin definiert, wie ein sauberer Code aussehen würde. In diesem Artikel werde ich die wichtigsten Punkte zum Schreiben von sauberem Code erläutern.

Ein sauberer Code ist einer, der effizient, einfach, lesbar und ohne Duplikate ist. Sie müssen diese Anweisungen befolgen, da es einfacher ist, Ihren Code von vornherein sauber zu schreiben, als schlecht geschriebenen Code zu bereinigen.

Aussagekräftige Namen

• Die Namen der Klassen, Methoden und Variablen sollten aussagekräftig und eindeutig benannt werden und zeigen, was sie tun sollen
• Ihre Benennung sollte aussprechbar sein, um die Kommunikation zwischen den Entwicklern zu erleichtern.
• Vermeiden Sie Akronyme oder zweideutige Namen, die diejenigen verwirren, die Ihren Code lesen.
• Verwenden Sie Namen, die die Systemdomäne, den Kontext und die zu lösenden Probleme darstellen.
• Verwenden Sie konsequent konzeptionelle Wörter. Wenn Sie beispielsweise das Wort „holen“ verwenden, dann verwenden Sie keine Wörter wie „holen“ oder „holen“. Bleiben Sie bei Ihrer Konvention.
• Versuchen Sie nicht, dasselbe Wort für zwei Zwecke zu verwenden

• Die Methoden sollten lesbar und verständlich sein.
• Die Blöcke wie „if and else“-Anweisungen und „while“-Anweisungen sollten eine Zeile lang sein.
• Die Methode sollte ihre Intention vermitteln.
• Beim Lesen der Funktion von oben nach unten sollten die Leser verstehen können, was Sie erreichen möchten. Die aufeinanderfolgenden Zeilen sollten zuordenbar sein. Außerdem sollte die Abstraktionsebene von oben nach unten verringert werden.
• Die Methoden sollten klein sein und bis zu 20 Zeilen haben.
• Jede Methode sollte eine Sache tun.
• Die Methoden sollten die Aufgabe vermitteln, die ihr Name vermuten lässt.
• Die optimale Anzahl von Parametern einer Methode ist Null, nach eins und zwei. Verwenden Sie den dritten Parameter nur, wenn Sie einen guten Grund haben.
• Vermeiden Sie Nebenwirkungen, was bedeutet, dass Ihre Methoden nichts ändern sollten, was nicht durch den Methodennamen impliziert wird
• Vermeiden Sie die Verwendung von Ausgabeargumenten für Abstraktionen auf hoher Ebene.
• Methoden sollten entweder etwas beantworten oder etwas tun, aber nicht beides.
• Vermeide Dopplungen. Setzen Sie wiederholte Codeblöcke in Methoden ein.

• Die Verwendung von Kommentaren ist ein Zeichen dafür, dass der von Ihnen geschriebene Code nicht klar genug ist.
• Kein Kommentar kann schlecht geschriebenen Code retten.
• Anstatt zu erklären, was eine Methode tut, geben Sie einen geeigneten Namen, der angibt, was die Methode tun soll. Dasselbe gilt für Variablennamen.
• Die wichtigen Punkte im Code können mit Kommentaren ausgedrückt werden.
• Kommentare sollten nicht verwendet werden, um darauf hinzuweisen, wer den Code geändert hat oder warum. Die Versionskontrolle tut das bereits.
• Vermeiden Sie das Auskommentieren von Code, der nicht verwendet wird, da dies zu Code-Smells führt. Entfernen Sie diese Art von Kommentaren einfach.

• Schreiben Sie den Code nicht in Spaghetti-Manier. Es ist schwer zu lesen.
• Die Klassen sollten 500 Zeilen nicht überschreiten. Kleinere Klassen können leicht verstanden werden.
• Halten Sie eine gute Zeichengrenze von etwa 120 pro Codezeile ein.
• Erstellen Sie einen Codestrom, indem Sie zusammenhängende Codezeilen nacheinander beibehalten.
• Verwenden Sie Leerzeichen zwischen Parametern, Operatoren und Kommas.

• Verwenden Sie Datenabstraktionen, um Schnittstellen bereitzustellen, die es den Entwicklern ermöglichen, die Daten zu manipulieren, ohne ihre Implementierung zu kennen.
• Datenstrukturen bilden eine Schnittstelle zur Manipulation der Daten. Sie erfordern keine signifikanten Methoden.

• Protokollieren Sie Fehler mit den Informationen zu den Ursachen. Geben Sie den Ort an, an dem der Fehler aufgetreten ist, und warum er aufgetreten ist.
• Geben Sie in Methoden nicht null zurück; leere Objekte zurückgeben.
• Übergeben Sie keine Nullparameter an die Methoden; Sie verursachen NullPointerExceptions.

Befolgen Sie die ERSTE Regel zum Testen

Der Test sollte sein;

• schnell
• unabhängig
• wiederholbar
• selbstvalidierend
• rechtzeitig

In Java sollten Variablen ganz oben in den Klassen stehen. Die Reihenfolge der verschiedenen Arten von Variablen ist wie folgt:

i) öffentliche statische konstante Variablen

ii) private statische Variablen

iii) private Instanzen von Variablen.

• Nach den Variablen sollten die Klassen mit den Methoden fortfahren.
• Der Klassenname sollte seinen Zweck angeben.
• Jede Klasse sollte eine Verantwortung haben.