Informatik 2.1 — Clean Code

Naming — der wichtigste Hebel

Schlechte Namen sind die häufigste Lesbarkeitsbremse. Gute Namen ersparen Kommentare und Tests.

Faustregeln:
  • Sprich aussprechbar: genymdhms ist hostile, generationTimestamp ist freundlich.
  • Suchbar: nicht e, sondern customer.
  • Vermeide Encoding: nicht m_dsc, nicht strName.
  • Klassen: Substantive (User, Account, Parser).
  • Methoden: Verben (postPayment, deletePage, save).
  • Boolesche: isActive, hasErrors, canEdit.
  • Konstante in CAPS: MAX_RETRIES = 5.
Vergleich:
// schlecht
function f(d) {
  let r = 0;
  for (let i = 0; i < d.length; i++) {
    if (d[i].s === 'A') r += d[i].v;
  }
  return r;
}

// gut
function sumActiveOrderValues(orders) {
  return orders
    .filter(o => o.status === 'A')
    .reduce((sum, o) => sum + o.value, 0);
}
Zurück zu Informatik