Kuidas te määratlete, et kood on kvaliteetne?

Kvaliteetne kood on lühike, loetav ja teiste arendajate jaoks arusaadav. See järgib heaks kiidetud kodeerimisstandardeid ja konventsioone.

Koodi kvaliteedi peamised kriteeriumid:

• Loetavus ja hooldatavus: Lihtne lugeda, mõista ja muuta.
• Tõhusus: Efektiivselt kasutab ressursse ja töötab kiiresti.
• Testitavus: Kirjutatud nii, et seda on lihtne katsetega katta.
• Usaldusväärsus: Töötab etteaimatavalt ega sisalda kriitilisi vigu.
• Skaleeritavus: Lihtne laiendada ja funktsionaalsust parandada.

Tööriistad ja praktikad kvaliteedi tagamiseks:

1. Linterid ja formatterid: eslint, prettier automaatseks kontrolliks ja vormindamiseks.
2. Testide kirjutamine: üksuse-, integratsiooni- ja E2E-testid.
3. Koodi ülevaatus: kolleegide poolt, potentsiaalsete probleemide avastamiseks.
4. Disainimustrite ja SOLID põhimõtete järgimine.
5. Hea dokumentatsioon: keeruliste koodilõikude ja API-de selgitused.

Näide halvasti loetavast koodist:

// Halb kood
function procData(d) {
  let res = [];
  for (let i = 0; i < d.length; i++) {
    if (d[i].val > 0) {
      res.push(d[i].val * 2);
    }
  }
  return res;
}

Näide kvaliteetsest koodist sama funktsionaalsusega:

// Hea kood. Kasutatakse arusaadavaid nimesid ja massiivide meetodeid
function processPositiveValuesDoubled(data) {
  return data
    .filter(item => item.value > 0) // Filtreerib positiivseid väärtusi
    .map(item => item.value * 2); // Korrutab väärtuse kahega
}