JavaScript-Namenskonventionen: Do's and Don'ts

Ich finde es erstaunlich, wie viele verschiedene Bedeutungen wir aus weniger als 30 Zeichen erhalten können. Ich spreche natürlich über das Alphabet mit einer gut platzierten Interpunktion. Von einer Liebesgeschichte bis zu einem Computerprogramm hat uns das Schreiben ermöglicht, außergewöhnlich unterschiedliche Welten zu erschaffen. Und die Sprache bietet im Allgemeinen einen Rahmen, in dem wir einen Strom von Ideen aufhängen können.

Die meisten Programmiersprachen scheinen sehr strenge Standards zu haben - bestimmte Begriffe müssen an bestimmten Stellen verwendet werden. Ein Bereich, in dem es eine enorme Freiheit gibt, ist die Art und Weise, wie wir diese Begriffe benennen.

Nehmen Sie dieses einfache Programm, das aus einer Reihe von Wörtern einen Satz erstellt, ein Interpunktionszeichen hinzufügt und ihn in der Konsole protokolliert:

Nichts Besonderes, oder? Was Sie jedoch möglicherweise nicht berücksichtigt haben, ist die Anzahl der Begriffe , für deren Benennung Sie verantwortlich waren.

Das obige Programm enthält 23 Wörter (ohne fest codierte Werte). Wir haben die Namen von 14 dieser Wörter kontrolliert. Das sind mehr als 60% von dem, was getippt wurde, war unsere Verantwortung zu benennen!

Unabhängig davon, ob Sie eine Unternehmensanwendung oder eine einfache Hello, World erstellen , möchten Sie, dass Ihr Programm wie ein Times Bestseller und nicht wie eine Mad Libs-Arbeitsmappe gelesen wird.

Dies ist kein Manifest zur Strukturierung einer gesamten JavaScript-Anwendung, sondern ein Kapitel zur Auswahl von Namen für die Dinge, in denen Sie die Freiheit haben, dies zu tun. Ich habe die verschiedenen Referenzen unten eingefügt, wenn Sie mehr erfahren möchten. Eine letzte Sache, die für alle unsere Konventionen und Standards von entscheidender Bedeutung ist, ist folgende:

Die meisten dieser Konventionen gelten nicht für Sie heute, sondern für Sie und die Personen, die morgen Ihren Code lesen.

Referenzen und weiteres Lernen

  1. "Clean Code" von Robert C. Martin - Eine großartige Lektüre für alle Sprachen. Es geht über Namenskonventionen hinaus und schlägt die gesamte Struktur Ihres Programms vor. Die Beispiele sind in Java, aber die Prinzipien gelten für JavaScript.
  2. "Clean Code JavaScript" von Ryan Mcdermott - Das obige Buch, aber neu für JavaScript gemacht. Es ist online verfügbar und kostenlos.
  3. Airbnb JavaScript Style Guide - Möglicherweise der umfassendste Style Guide für JavaScript. Es enthält nicht nur das Was, sondern auch das Warum. (Wenn Sie sich auf einem kleinen Gerät befinden, müssen Sie möglicherweise auf "Alle Readme-Dateien anzeigen" klicken, um das gesamte Dokument anzuzeigen.)
  4. W3 JavaScript Style Guide - Kurzer und übersichtlicher Leitfaden.
  5. Googles ES6 Style Guide - Googles Style Guide für JavaScript.

Danke fürs Lesen!

woz

Folge mir auf Twitter.