클린 코드 변수: 의미 있는 이름과 매직 넘버 없애기
약어 변수명, 중언부언하는 이름, 매직 넘버, 하드코딩된 값을 bad/good 예시로 비교하며 변수 이름으로 의도를 전하는 방법을 정리했습니다.
1분 읽기#클린 코드
2024년에 쓴 글이라 지금과 다른 내용이 있을 수 있습니다.
코드는 커뮤니케이션이다
javascript
const d = "" // 경과 시간위 코드는 커뮤니케이션 실패다.
Bad: 뜻을 알 수 없는 약어
javascript
if(t === DaysType.Day){
}//t가 무슨 의미일까요?
const cbm = (d: Days[]) => d.map((dd:Days)=> dd.month());
// cbm, d, dd가 무슨 의미?
const sd = data.get("sopmeData")
//sd 가 무슨의미? Good: 의도가 드러나는 이름
javascript
if(selectedDay === DaysType.Day){
}
const getSelectedMonth = (selectedDays: Days[]) => selectedDays.map((item:Days)=> item.month());
const selectedDay = data.get("sopmeData")
- 주석은 해결책이 아니다
중언부언하지 마라
javascript
//bad
const stringArray =
//good
const replyComments =
매직 넘버(Magic number) 금지
javascript
//bad
if(comments.length > 140 ) {
throw new Error("exceed comment length");
}
//Good
const twitterCommentLimitCount = 140;
if(comments.length > twitterCommentLimitCount) {
throw new Error("exceed comment length")
}
javascript
//bad
travelCities[0].someValue;
//Good
const departureCityidx = 0
travelCities[departureCityidx].someValue;
//array destructing
const [departureCity] = travelCities;
departureCity.someValue;
하드코딩된 값은 변수 또는 열거형(enum)으로
javascript
//bad
if(someCode === "BTC")
//good
const bitcoinCode = "BTC"
if(someCode===bitcoinCode)
//enum case
enum CoinCode {
BITCOIN ="BTC"
ETHERUM ="ETH"
}
if(someCode === CoinCode.BITCOIN) 같은 주제의 글
클린 코드 함수: 순수 함수와 한 가지 일만 하는 함수
외부 변수에 기대는 함수와 부수효과가 왜 문제인지, 비밀번호 체크에 세션 초기화가 섞인 예시로 함수가 한 가지 일만 해야 하는 이유를 정리했습니다.
1분 읽기#클린 코드