Funktionen benennen
Gute Funktionsnamen zu wählen, ist ein wesentlicher Teil davon, guten Code zu schreiben.
Beachte die folgenden Empfehlungen, wenn du deine Funktion benennst.
Wähle aussagekräftige Funktionsnamen
Wenn du deine Funktion benennst, sollte klar sein, was sie tut.
Zum Beispiel hat die Funktion get(studentId, subject) keinen aussagekräftigen Namen, und deshalb ist nicht klar, was sie tut.
Vielleicht soll sie die Note einer Person in einem Fach ermitteln oder ihren Anmeldestatus.
Ein besserer Name wäre getStudentGrade(studentId, subject), denn er sagt genau, was die Funktion tut.
Mach den Funktionsnamen nicht zu lang
Achte darauf, den Funktionsnamen nicht zu lang zu machen.
Zum Beispiel ist checkStudentFailOrPassOrMeritOrDistinction(mark) ein unnötig langer Funktionsname.
Je länger der Name ist, desto schwerer lässt er sich merken und desto mehr Platz nimmt er auf dem Bildschirm ein.
Mach den Funktionsnamen nicht zu kurz
Umgekehrt kann ein zu kurzer Funktionsname die Lesenden ebenfalls verwirren.
Zum Beispiel ist checkFPMD(mark) ein schlechter Funktionsname, denn es ist nicht sofort klar, was „FPMD“ bedeutet.
Verwende einen Namen, den alle verstehen
Dein Funktionsname sollte für alle verständlich sein, die deinen Code lesen.
Ein obskurer Funktionsname wie DeathStar() mag für dich amüsant sein, aber er sagt nichts über seinen Zweck aus und kann andere Entwickler, die deinen Code lesen, verwirren.
Leg dich auf eine Konvention für die Benennung von Operationen fest
Bleib bei einer Konvention für die Benennung von Operationen, die dasselbe tun.
Wenn du die Funktion zum Auslesen eines Namens zum Beispiel getStudentName() nennst, solltest du für das Auslesen einer Note kein anderes Verb im Funktionsnamen verwenden (z. B. retrieveStudentGrade()).
Verwende nicht dasselbe Wort für zwei Dinge
Wenn du add schon für die Addition zweier Zahlen verwendest, solltest du es nicht auch benutzen, um eine Gruppe von Elementen in eine Sammlung zu stecken.
Verwende stattdessen insert oder append.
