Пишите более чистый код на JavaScript #4 Комментарии

Это третья часть серии о чистом коде. Если вы хотите начать сначала, просто нажмите здесь!

Комментируйте код только при необходимости

Чистый код читабелен и обычно не требует дополнительных комментариев. Так что комментируйте только те вещи, которые имеют сложную бизнес-логику. Это поможет сохранить вашу кодовую базу чистой и легкой для понимания.

// Don't ❌
function hashIt(data) {
  // The hash
  let hash = 0;

  // Length of string
  const length = data.length;

  // Loop through every character in data
  for (let i = 0; i < length; i++) {
    // Get character code.
    const char = data.charCodeAt(i);
    // Make the hash
    hash = (hash << 5) - hash + char;
    // Convert to 32-bit integer
    hash &= hash;
  }
}
// Do ✅
function hashIt(data) {
  let hash = 0;
  const length = data.length;

  for (let i = 0; i < length; i++) {
    const char = data.charCodeAt(i);
    hash = (hash << 5) - hash + char;

    // Convert to 32-bit integer
    hash &= hash;
  }
}

Не коммитить закомментированный код

// Don't ❌
doSomething();
// doSomethingElse();
// doSomethingOld();
// Do ✅
doSomething();

Не иметь комментариев журнала

Используйте git log для получения истории. В вашей кодовой базе нет необходимости в мертвом или журнальном коде.

// Don't ❌
/**
 * 2022-09-10: Removed conditions as they were not needed
 * 2021-10-01: Added conditions
 * 2020-03-03: Fixed NaN values issue
 * 2020-02-14: Added multiply values function
 */
function multiplyValues(a, b) {
  return a * b;
}
// Do ✅
function multiplyValues(a, b) {
  return a *b;
}

Избегайте позиционных маркеров

Это поможет вам лучше понять код и упростить работу с ним.

// Don't ❌
////////////////////////////////////////////////////////////////////
// Initial Car Object
////////////////////////////////////////////////////////////////////
car = {
  colour: "red",
  productionYear: 2022
};

////////////////////////////////////////////////////////////////////
// Update Car Function
////////////////////////////////////////////////////////////////////
const updateCar = () => {
  // ...
};
// Do ✅
car = {
  colour: "red",
  productionYear: 2022
};

const updateCar = () => {
  // ...
};

Это конец серии. Если вам понравилось, следите за моими историями, чтобы узнать больше!