Nomen est omen
Namen spielen beim Schreiben von Code eine essenzielle Rolle.
Gut gewählte Namen können viele Grübeleien, Verwirrungen und Missverständnisse sowie Fehler vermeiden, und machen den Code leichter lesbar.
Gute Namen sind:
- Selbsterklärend
- Klar
- Eindeutig
- Unmissverständlich
- Einprägsam
- Sagen genau was das Ding tut oder enthält, nicht mehr und nicht weniger
- Müssen nicht kommentiert werden
Zum Beispiel hier (C# Code):
Der Klassen-Name sagt aus „Ich enthalte Geometrie-Methoden“, die erste Methode sagt „Ich berechne eine Kreisfläche, wenn du mir die Radius-Länge gibst“, usw.
Man braucht nicht (mit F12 ins Visual Studio) sich den Code innerhalb einer Methode zu lesen, um zu wissen, was es tut.
public class GeometryCalculator
{
public double CalculateCircleSurface(double radiusLength)
{
return radiusLength * radiusLength * Math.PI;
}
public double CalculateSquareSurface(double sideLength)
{
return sideLength * sideLength;
}
}
Nomen est omen… eben.