Naming Things in Code

Summary

In diesem Video wird die Bedeutung von guten Namensgebungen in der Programmierung hervorgehoben. Der Sprecher kritisiert schlechte Praktiken wie die Verwendung von einstelligen Variablennamen, Abkürzungen und die Einbeziehung von Typen in Variablennamen. Er betont, dass aussagekräftige Namen die Lesbarkeit und Wartbarkeit des Codes verbessern. Außerdem wird die Problematik von 'Utils'-Klassen behandelt und vorgeschlagen, Funktionen in geeignete Klassen zu verschieben. Abschließend ermutigt der Sprecher dazu, strukturierte Namenskonventionen zu befolgen, um den Code klarer und leichter verständlich zu gestalten.

Takeaways

• 😀 Vermeide die Verwendung von Variablen mit einem einzelnen Buchstaben, da sie keine Informationen über den Zweck der Variablen liefern.
• 😀 Abkürzungen sollten nicht verwendet werden, da sie auf Kontext angewiesen sind und Verwirrung stiften können.
• 😀 Typen in Variablennamen einzufügen, ist in statisch typisierten Sprachen nicht mehr nötig, da der Typ klar aus dem Namen ersichtlich sein sollte.
• 😀 Die Praxis, Interfaces mit 'I' zu kennzeichnen, fügt keinen Wert hinzu und kann den Code unnötig komplizieren.
• 😀 Vermeide es, Klassen mit 'Base' oder 'Abstract' zu benennen, da dies die Verständlichkeit der Klassennamen nicht verbessert.
• 😀 Funktionen sollten in logische Klassen und nicht in eine generische 'Utils'-Klasse gruppiert werden, um die Codeorganisation zu verbessern.
• 😀 Verwende beschreibende Namen für Variablen und Funktionen, um deren Zweck klar zu kommunizieren.
• 😀 Einheiten sollten in Variablennamen aufgenommen werden, um den erwarteten Eingabewert zu verdeutlichen, wie z.B. 'delaySeconds'.
• 😀 Überprüfe regelmäßig deinen Code auf Konsistenz in der Namensgebung und Klarheit.
• 😀 Der Struktur des Codes sollte besondere Aufmerksamkeit geschenkt werden, um die Lesbarkeit und Wartbarkeit zu erhöhen.

Q & A

Was sind laut dem Skript die zwei schwierigen Dinge in der Informatik?

Die zwei schwierigen Dinge sind Cache-Invalidierung und Benennung von Dingen.

Warum wird empfohlen, Variablen nicht mit einem einzelnen Buchstaben zu benennen?

Einzelne Buchstaben geben keine aussagekräftigen Informationen über die Variable, was die Lesbarkeit und Wartbarkeit des Codes beeinträchtigt.

Welchen Einfluss hatten Abkürzungen auf die Programmierung in der Vergangenheit?

Abkürzungen wurden genutzt, um Tippaufwand zu sparen und weil Bildschirme eine begrenzte Breite von 80 Zeichen hatten. Heutzutage sind Bildschirme jedoch größer und das Schreiben von längeren Variablennamen erfordert weniger Aufwand.

Was wird über die Verwendung von Typen in Variablennamen gesagt?

Es wird empfohlen, Typen nicht in Variablennamen aufzunehmen, da moderne statisch typisierte Sprachen bereits den Typ der Variable anzeigen.

Wie sollte man mit Einheiten in Variablennamen umgehen?

Es ist ratsam, Einheiten in Variablennamen anzugeben, um Klarheit darüber zu schaffen, in welcher Einheit der Wert angegeben wird, z.B. 'delaySeconds' für eine Verzögerungszeit in Sekunden.

Was ist der Nachteil von Konventionen wie 'I' für Schnittstellen in C#?

Das Voranstellen von 'I' zu Schnittstellennamen bringt keinen wirklichen Nutzen, da der Verbraucher des Codes in der Regel nicht interessiert ist, ob es sich um eine Schnittstelle, eine Klasse oder eine abstrakte Klasse handelt.

Warum sollten Klassen nicht mit 'Base' oder 'Abstract' benannt werden?

Diese Benennungen geben keine klare Vorstellung davon, was die Klasse tatsächlich repräsentiert. Stattdessen sollte man die Kindklasse spezifisch benennen und die Elternklasse einfach benennen.

Was ist ein häufiges Anti-Muster in der Code-Organisation?

Ein häufiges Anti-Muster ist das Bündeln von Funktionen in einer einzigen 'Utils'-Klasse oder einem Modul, anstatt die Funktionen sinnvoll in entsprechenden Klassen zu organisieren.

Wie kann man die Lesbarkeit und Wartbarkeit von Code verbessern?

Indem man schlechte Benennungsmuster vermeidet, die Struktur des Codes überdenkt und Funktionen sinnvoll in Klassen organisiert.

Was wird im Skript über die Namensgebung von Methoden in 'Utils'-Klassen gesagt?

Es wird empfohlen, Methoden nicht in einer 'Utils'-Klasse zu belassen, sondern sie in spezifische Klassen mit beschreibenden Namen zu verschieben, um die Organisation und Lesbarkeit zu verbessern.