댓글 쓰기가 나쁜 이유

함수 이름 변경

보시다시피 함수 이름은 많은 것을 말하지 않으므로 단어 대신 더 설명적인 이름을 사용하면 확실히 첫 번째 주석이 필요하지 않습니다. 내 제안은 getRemainingDaysToBirthday 또는 calculateRemainingDaysToBirthday입니다.

설명적 조건 사용

// if birthday has already passed, set next year as birthday
if (today > upcomingBday) {
  upcomingBday.setFullYear(today.getFullYear() + 1);
}

여기서 주석을 사용하지 않고 코드 내부의 조건을 설명할 수 있습니다.

const birthdayHasAlreadyPassed = today > nextBirthday;
if (birthdayHasAlreadyPassed) {
  upcomingBday.setFullYear(today.getFullYear() + 1);
}

쉽죠?

다른 기능 사용

// getTime() returns in milliseconds so we divide the result in milliseconds to get number of days
const result = Math.ceil((upcomingBday.getTime() - today.getTime()) / (24 * 60 * 60 * 1000));

우선 이 코드를 읽는 사람은 아마도 24 * 60 * 60 * 1000가 특히 1000가 무엇을 하는지 이해하지 못할 것입니다. 대신 설명 상수를 사용하여 각 숫자가 무엇을 나타내는지 설명할 수 있습니다.

  const hoursInADay = 24;
  const minutesInAnHour = 60;
  const secondsInAMinute = 60;
  const oneSecondInMilliseconds = 1000;

하지만 첫 번째 부분은 어떻습니까? 함수를 사용하여 가독성을 높일 수 있으며, 이 경우 이 코드가 수행하는 작업을 설명합니다.

function getDaysToBirthday(nextBirthday, today) {
  const hoursInADay = 24;
  const minutesInAnHour = 60;
  const secondsInAMinute = 60;
  const oneMillisecond = 1000;
  const OneDayInMilliseconds = hoursInADay * minutesInAnHour * secondsInAMinute * oneMillisecond;

  const daysToBirthday = Math.ceil(nextBirthday.getTime() - today.getTime() / OneDayInMilliseconds);

  return daysToBirthday;
}