Variablen

Verwenden Sie aussagekräftige und aussprechbare Variablennamen

Schlecht:

const yyyymmdstr = moment().format("YYYY/MM/DD");

Gut:

const currentDate = moment().format("YYYY/MM/DD");

Verwenden Sie dieselbe Terminologie für denselben Variablentyp

Schlecht:

getUserInfo();
getClientData();
getCustomerRecord();

Gut:

getUser();

Verwenden Sie suchbare Namen

Wir werden mehr Code lesen als schreiben. Daher muss der von uns geschriebene Code lesbar und durchsuchbar sein. Wenn wir Variablen nicht aussagekräftig benennen, erschweren wir es den Lesern, das Programm zu verstehen. Verwenden Sie suchbare Namen. Tools wie buddy.js und ESLint können unbenannte Konstanten identifizieren.

Schlecht:

// What the heck is 86400000 for?
setTimeout(blastOff, 86400000);

Gut:

// Declare them as capitalized named constants.
const MILLISECONDS_PER_DAY = 60 * 60 * 24 * 1000; //86400000;

setTimeout(blastOff, MILLISECONDS_PER_DAY);

Verwenden Sie erklärende Variablen

Schlecht:

const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
saveCityZipCode(
  address.match(cityZipCodeRegex)[1],
  address.match(cityZipCodeRegex)[2]
);

Gut:

const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
const [_, city, zipCode] = address.match(cityZipCodeRegex) || [];
saveCityZipCode(city, zipCode);

Vermeiden Sie mentale Zuordnungen

Explizit ist besser als implizit.

Schlecht:

const locations = ["Austin", "New York", "San Francisco"];
locations.forEach(l => {
  doStuff();
  doSomeOtherStuff();
  // ...
  // ...
  // ...
  // Wait, what is `l` for again?
  dispatch(l);
});

Gut:

const locations = ["Austin", "New York", "San Francisco"];
locations.forEach(location => {
  doStuff();
  doSomeOtherStuff();
  // ...
  // ...
  // ...
  dispatch(location);
});

Vermeiden Sie überflüssigen Kontext

Wenn Ihr Klassen-/Objektname bereits Kontext liefert, wiederholen Sie ihn nicht im Variablennamen.

Schlecht:

const Car = {
  carMake: "Honda",
  carModel: "Accord",
  carColor: "Blue"
};

function paintCar(car, color) {
  car.carColor = color;
}

Gut:

const Car = {
  make: "Honda",
  model: "Accord",
  color: "Blue"
};

function paintCar(car, color) {
  car.color = color;
}

Verwenden Sie Standardparameter statt Kurzschlussauswertung oder Bedingungen

Standardparameter sind oft übersichtlicher als Kurzschlussauswertungen. Beachten Sie: Die Funktion ersetzt nur undefined-Argumente durch Standardwerte. Andere "falsy"-Werte wie '', "", false, null, 0 und NaN werden nicht ersetzt.

Schlecht:

function createMicrobrewery(name) {
  const breweryName = name || "Hipster Brew Co.";
  // ...
}

Gut:

function createMicrobrewery(name = "Hipster Brew Co.") {
  // ...
}