GlamorousPlaintiveNotification # Cleancode

Replit 안되서 노션에 답안 작성합니다.

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

// GOOD 😎
// 위 코드를 깨끗하게 다시 작성해 주세요.

// 어떻게 고쳤는지, 사례에서 무엇을 배워야 하는지 설명해주세요.

------------------------------------------------------
// BAD 더러운 코드 😣
// Hint❕ : 의미있는 이름을 사용해주세요.

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

// GOOD 😎
// 위 코드를 깨끗하게 다시 작성해 주세요.

// 어떻게 고쳤는지, 사례에서 무엇을 배워야 하는지 설명해주세요.

------------------------------------------------------
// BAD 더러운 코드 😣
// Hint❕ : 불필요하게 반복하지 마세요.

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

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

// GOOD 😎
// 위 코드를 깨끗하게 다시 작성해 주세요.

// 어떻게 고쳤는지, 사례에서 무엇을 배워야 하는지 설명해주세요.

===

// 하루의 밀리초 수 (1일 = 24시간 * 60분 * 60초 * 1000밀리초)
const ONE_DAY_IN_MILLISECONDS = 24 * 60 * 60 * 1000;

// 로켓 발사를 의미하는 명확한 함수 이름 사용함
setTimeout(rocketLaunch, ONE_DAY_IN_MILLISECONDS);

매직 넘버 제거:
- 기존 코드에서는 86400000이라는 매직 넘버를 사용했었음. 이 숫자가 하루를 의미한다는 것이 직관적이지 않아, ONE_DAY_IN_MILLISECONDS라는 의미 있는 상수로 대체함.
- 이로써 코드의 가독성을 높이고, 숫자가 의미하는 바를 명확하게 전달함.
함수 이름 개선:
- blastOff라는 함수 이름을 rocketLaunch로 변경함.
- blastOff도 로켓 발사를 의미할 수 있지만, 보다 명확한 rocketLaunch로 이름을 변경하여 코드의 목적을 더 명확하게 표현함.
- 이는 다른 개발자들이 코드의 기능을 빠르게 이해하는 데 도움을 줌.
- 코드의 가독성이 높아지고, 변경이 필요한 경우에도 한 곳에서만 수정하면 되어 유지보수가 용이해짐.
명확하고 검색하기 쉬운 이름 사용:
- 함수나 변수의 이름을 지을 때, 그 기능이나 역할을 명확하게 나타내는 것이 중요함. 의미가 불명확한 이름이나 줄임말을 피하고, 기능을 바로 이해할 수 있도록 명명해야 함.
- 특히 팀 프로젝트에서, 검색이 용이한 이름은 다른 개발자들이 코드 내에서 특정 기능을 쉽게 찾을 수 있게 해줌.

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

변수 이름 변경:
- yyyymmdstr이라는 변수 이름은 의미가 불명확하고, 코드의 목적을 이해하기 어렵게 만듦. 이 이름을 formattedDate로 변경함.
- formattedDate는 이 변수에 날짜가 특정 형식으로 포맷팅된 문자열이 담겨 있다는 것을 명확하게 나타냄.
의미 있는 이름 사용:
- 변수명은 그 자체로 데이터를 명확하게 표현해야 함. 코드의 가독성을 높이기 위해 의미가 모호한 약어보다는, 그 역할을 직관적으로 나타낼 수 있는 이름을 사용하는 것이 중요함.
- yyyymmdstr라는 이름은 코드를 처음 접하는 사람에게는 이해하기 어려울 수 있음. 반면 formattedDate는 그 내용이 무엇인지 바로 이해할 수 있게 해줌.
코드 가독성 향상:
- 코드의 가독성을 높이기 위해, 변수나 함수의 이름은 최대한 명확하고 직관적으로 지어야 함. 이렇게 하면 다른 개발자나 미래의 자신이 코드를 더 쉽게 이해하고 유지보수할 수 있음.