mitmario.dev

Namen und kleine Funktionen

JavaScript Im Browser 4 Min Lesezeit 3 BeispieleLektion 1 von 8

Code kann richtig rechnen und trotzdem so geschrieben sein, dass sich niemand an ihn herantraut. Neue Sprachmittel kommen ab hier keine mehr dazu. Es geht um den Unterschied zwischen Code, der läuft, und Code, mit dem man arbeiten kann. Davon hängt ab, wie lange eine Änderung dauert.

Erst einmal ansehen, worum es geht

Code, den man entziffern muss
const d = [
  { t: "Fahrradhelm", p: 4900, m: 1 },
  { t: "Fahrradschloss", p: 6900, m: 1 },
  { t: "Aufkleber", p: 240, m: 2 },
];

function calc(a) {
  let s = 0;
  for (const x of a) {
    s = s + x.p * x.m;
  }
  // 5000 = Grenze, 495 = Pauschale
  if (s < 5000) {
    s = s + 495;
  }
  return (s / 100).toFixed(2).replace(".", ",") + " €";
}

console.log(calc(d));

Diese Funktion ist richtig. Sie rechnet einen Warenkorb zusammen, schlägt bei kleinen Bestellungen den Versand drauf und gibt einen deutschen Betrag zurück, alles in elf Zeilen. Trotzdem liest sie sich wie eine Geheimschrift. Weder s noch x.m verraten etwas, und warum dort 5000 steht und woanders 495, steht nirgends.

Soll die Versandgrenze auf 3000 sinken, musst du erst die ganze Funktion verstehen, bevor du die Zahl überhaupt findest. Steht dieselbe 5000 an drei Stellen im Projekt, findest du sie zweimal und übersiehst die dritte.

Noch etwas fehlt, und das fällt erst auf, wenn man danach sucht. Du kannst diese Funktion nichts fragen. In der Eingabezeile der Console antwortet calc(d) im ersten Beispiel mit "122,80 €", dem ganzen Ergebnis. Fragst du nach dem Versand allein, antwortet typeof versandkostenInCent mit "undefined". Einen Versand gibt es in diesem Code nicht, nur die elf Zeilen als Ganzes.

Derselbe Code, nur mit Namen

Derselbe Code mit Namen
const VERSANDFREI_AB_CENT = 5000;
const VERSANDKOSTEN_CENT = 495;

const warenkorb = [
  { titel: "Fahrradhelm", preisInCent: 4900, menge: 1 },
  { titel: "Fahrradschloss", preisInCent: 6900, menge: 1 },
  { titel: "Aufkleber", preisInCent: 240, menge: 2 },
];

function zwischensummeInCent(posten) {
  let summe = 0;
  for (const eintrag of posten) {
    summe = summe + eintrag.preisInCent * eintrag.menge;
  }
  return summe;
}

function versandkostenInCent(zwischensumme) {
  if (zwischensumme >= VERSANDFREI_AB_CENT) {
    return 0;
  }
  return VERSANDKOSTEN_CENT;
}

function gesamtpreisInCent(posten) {
  const zwischensumme = zwischensummeInCent(posten);
  return zwischensumme + versandkostenInCent(zwischensumme);
}

function euroText(cent) {
  return (cent / 100).toFixed(2).replace(".", ",") + " €";
}

console.log("Zwischensumme:", euroText(zwischensummeInCent(warenkorb)));
console.log("Versand:", euroText(versandkostenInCent(zwischensummeInCent(warenkorb))));
console.log("Gesamt:", euroText(gesamtpreisInCent(warenkorb)));

Hier sind zwei Dinge passiert, und beide sind einfacher, als sie klingen.

Die Zahlen haben einen Namen bekommen. VERSANDFREI_AB_CENT steht einmal da. Ändert sich die Grenze, änderst du eine Zeile, und zwar die, die so heißt wie das, was sich ändern soll. Für Werte, die sich im Programmablauf nie ändern, ist Großschreibung mit Unterstrich üblich. Das ist reine Übereinkunft, aber eine hilfreiche, denn man sieht sofort, dass hier niemand etwas zuweist.

Außerdem ist die Funktion in vier Funktionen zerfallen. Jede tut eine Sache, und der Name sagt, welche. versandkostenInCent kannst du lesen, verstehen und ändern, ohne zu wissen, was euroText macht.

Und jetzt kannst du fragen, ohne eine Zeile zu lesen. Im zweiten Beispiel antwortet versandkostenInCent(4999) mit 495 und versandkostenInCent(5000) mit 0. Die Grenze gilt also einschließlich, und das weißt du aus dem laufenden Code und nicht aus einem Kommentar. VERSANDFREI_AB_CENT antwortet mit 5000, zwischensummeInCent(warenkorb) mit 12280.

Eine Funktion, die man einzeln aufrufen kann, kann man auch einzeln prüfen. Davon lebt die nächste Lektion.

Die Regel dahinter ist alt. Ein Name sagt, was etwas ist oder was es tut, nie wie es gemacht wird. Also kursliste statt arr und berechneGesamtpreis statt calc, Substantive für Werte und Verben für Funktionen.

Eine Funktion tut eine Sache

Ob eine Funktion zwei Dinge tut, verrät ihr Name. Lässt er sich nur mit einem „und“ bilden, sind es zwei. speichereUndZeichneNeu ist zwei Funktionen, die noch nicht getrennt wurden, ladeDatenUndZeigeFehler auch.

Das hat einen praktischen Grund. Eine Funktion, die nur rechnet, lässt sich mit Testfällen abnehmen, und so werden in diesem Kurs die meisten Aufgaben geprüft. Rechnet sie und schreibt dabei ins DOM, kann man sie nur noch ansehen. Warum das so viel ausmacht, kommt in der nächsten Lektion.

Eine Zahl für die Länge gibt es nicht. Musst du beim Lesen scrollen, um den Anfang wiederzufinden, ist die Funktion zu lang. Das ist ungenau und trotzdem der beste Maßstab, den es gibt.

Wahrheitswerte und Kommentare

Wahrheitswerte und der Kommentar, der bleibt
const VERSANDFREI_AB_CENT = 5000;

// Der Name sagt nicht, was der Wert bedeutet.
// Ist das der Versand, kostet er etwas, ist er frei?
const versand = 4200 < VERSANDFREI_AB_CENT;
console.log("versand:", versand);

// Mit ist am Anfang liest sich der Aufruf wie ein Satz.
function istVersandkostenfrei(zwischensumme) {
  return zwischensumme >= VERSANDFREI_AB_CENT;
}

console.log("4200 frei?", istVersandkostenfrei(4200));
console.log("6000 frei?", istVersandkostenfrei(6000));

if (istVersandkostenfrei(6000)) {
  console.log("Der Versand ist frei.");
}

// Dieser Kommentar bleibt, denn kein Name kann ihn ersetzen.
// Der Zahlungsdienst rundet zu unseren Gunsten, unsere
// Buchhaltung will aber abrunden. Deshalb floor, nicht round.
function provisionInCent(betragInCent) {
  return Math.floor(betragInCent * 0.029);
}

console.log("Provision auf 14300:", provisionInCent(14300));
console.log("Mit round wären es:", Math.round(14300 * 0.029));

Ein Name für einen Wahrheitswert beginnt mit ist, hat oder kann, also istVersandkostenfrei, hatFehler, kannBearbeiten. Dann liest sich jedes if wie ein deutscher Satz, und niemand muss überlegen, ob true jetzt „ja“ oder „nein“ bedeutet.

Der Kommentar im ersten Beispiel war eine Notlösung. Er erklärte Zahlen, die einen Namen gebraucht hätten. Solche Kommentare verschwinden, sobald der Name da ist, und das ist gut so, denn Kommentare veralten. Der Code ändert sich, der Kommentar bleibt stehen, und irgendwann steht dort etwas Falsches.

Der Kommentar am Ende des dritten Beispiels ist anders. Er hält fest, warum dort Math.floor steht und nicht Math.round, und bei 14300 Cent macht das den Unterschied zwischen 414 und 415. Das sieht man dem Code nicht an, es steht in keiner Zeile, und ohne den Kommentar würde der nächste Mensch es wieder aufräumen.

Ich halte es so. Der Code sagt, was passiert, und ein Kommentar sagt, warum es so passiert. Erzählt ein Kommentar nur den Code nach, fliegt er raus, und ich suche stattdessen einen besseren Namen.

Die Reihenfolge in einer Datei

Eine Vorschrift gibt es nicht, aber eine Ordnung, die fast überall funktioniert. Du siehst sie in den Beispielen dieser Lektion. Ganz oben stehen die Konstanten, damit die Stellschrauben sofort zu sehen sind. Darunter kommen die Hilfsfunktionen, und ganz unten steht das, was das Programm tatsächlich startet.

Wer die Datei zum ersten Mal öffnet, sieht so oben, womit gerechnet wird, und unten, was passiert. Die Details in der Mitte liest er nur, wenn er sie braucht.

Zu lang und zu klein

Bei langen Namen kommt schnell der Einwand, das tippe sich schlecht. Stimmt, und es spielt keine Rolle. Ein Name wird einmal getippt, danach ergänzt ihn der Editor von selbst, und gelesen wird er hundertmal. Spart er beim Lesen eine Rückfrage, hat er sich in derselben Minute bezahlt gemacht.

Der Gegenreflex geht in die andere Richtung. Man zerlegt alles, bis jede Funktion drei Zeilen hat. Wer für jeden Einzelschritt eine Funktion baut, muss beim Lesen zwischen zwanzig Stellen hin und her springen. Die passende Größe ist die, bei der eine Funktion einen Gedanken beschreibt.

In der Aufgabe wird eine unleserliche Warenkorb-Funktion mit Pfand neu gebaut, in Stücken mit Namen.

Zum Mitnehmen

Werte heißen nach dem, was sie sind, Funktionen nach dem, was sie tun, und jede Funktion tut nur eine Sache. Ein Kommentar steht nur da, wo der Code das Warum nicht selbst sagen kann.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe im Editor, direkt im Browser geprüft

    Öffnet sich mit dem Basis Konto.