Jak określasz, że kod jest napisany jakościowo?

Kod wysokiej jakości jest zwięzły, czytelny i zrozumiały dla innych programistów. Podąża za powszechnie przyjętymi konwencjami i standardami kodowania.

Główne kryteria jakości kodu:

• Czytelność i łatwość utrzymania: Łatwy do czytania, rozumienia i modyfikowania.
• Wydajność: Efektywnie wykorzystuje zasoby i działa szybko.
• Testowalność: Napisany w sposób, który ułatwia pokrycie testami.
• Niezawodność: Działa przewidywalnie i nie zawiera krytycznych błędów.
• Skalowalność: Łatwo rozszerzalny i ulepszany.

Narzędzia i praktyki zapewniające jakość:

1. Lintery i formatery: eslint, prettier do automatycznego sprawdzania i formatowania kodu.
2. Pisanie testów: Testy jednostkowe, integracyjne i E2E.
3. Przegląd kodu: Przegląd przez kolegów w celu wykrycia potencjalnych problemów.
4. Przestrzeganie wzorców projektowych i zasad SOLID.
5. Dobra dokumentacja: Wyjaśnienie trudnych fragmentów kodu i API.

Przykład słabo czytelnego kodu:

// Zły kod
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;
}

Przykład wysokiej jakości kodu z tymi samymi funkcjami:

// Dobry kod. Użycie czytelnych nazw i metod tablic
function processPositiveValuesDoubled(data) {
  return data
    .filter(item => item.value > 0) // Filtruje elementy z dodatnią wartością
    .map(item => item.value * 2); // Podwaja wartość
}