[TIL/Clean Code] Assignment #03

TIL (Today I Learned)

 

오늘 읽은 범위

2장 의미 있는 이름까지

 

 

책에서 기억하고 싶은 내용

의도를 분명히 밝혀라!

변수의 존재 이유, 수행 기능, 사용 방법을 변수 이름을 통해 알 수 있어야 함

//올바른 예시
int elapsedTimeInDays;

 

그릇된 정보를 피하라!

널리 쓰이는 의미가 있는 단어를 다른 의미로 사용하면 안 됨

여러 계정을 그룹으로 묶을 때 : accountList (X), accountGroup (O)

 

서로 흡사한 이름을 사용하면 안 됨

 

 

의미 있게 구분해라!

//의미 구분이 정확히 안됨
getActiveAccount();
getActiveAccounts();
getActiveAccountInfo();

 

 

발음하기 쉬운 이름을 사용하라!

 

 

검색하기 쉬운 이름을 사용하라!

 

인코딩을 피하라!

변수 이름에 타입을 인코딩할 필요 없다

//잘못된 예시
PhoneNumber phoneString;

 

멤버 변수에 m_이라는 접두어를 붙일 필요가 없다.

 

인터페이스 클래스와 구현 클래스의 경우 인코딩이 필요하다.

저자는 주로 구현 클래스 이름 뒤에 Imp를 넣는다. ex) ShapeFactoryImp

 

 

자신의 기억력을 자랑하지 마라

범위가 작고 다른 이름과 충돌하지 않는, 루프에서 사용하는 i, j, k와 같은 경우를 제외하고 한 글자 변수는 옳지 않다.

 

클래스 이름

클래스 이름과 객체 이름은 명사나 명사구가 적합 (동사 사용 X)

좋은 예) Customer, WikiPage

나쁜 예) Manager, Data

 

메서드 이름

메서드 이름은 동사나 동사구가 적합 (동사 + 명사)

접근자, 변경자, 조건자는 값 앞에 get, set, is를 붙임

 

기발한 이름은 피하라

 

한 개념에 한 단어를 사용하라

fetch, retrieve, get 중 하나만 선택

controller, manager, driver 중 하나만 선택

 

 

말장난을 하지 마라

한 단어를 두 가지 목적으로 사용하지 마라

1. 기존 값을 더하는 경우 2. 집합에 값 하나를 추가하는 경우

서로 다른 2가지 목적이 있을 때, add 한 단어를 사용하지 말고

1번의 목적에는 add를 사용, 2번의 목적에는 append를 사용

 

 

해법 영역에서 가져온 이름을 사용하라

전산 용어, 알고리즘 이름, 패턴 이름, 수학 용어 등을 사용해도 괜찮다.

 

 

문제 영역에서 가져온 이름을 사용하라

책에는 구체적인 예시가 없지만, 만약 은행 파산 관련 코드를 작성하고 있다면 bankruptcy와 같은 단어를 사용해도 된다는 뜻 같다.

 

의미 있는 맥락을 추가하라

firstName, lastName, street 등의 주소를 나타내는 변수가 있다면 의미 있는 맥락인 'addr'를 접두어로 추가한다.addrFirstName, addrLastName, addrStreet

 

 

불필요한 맥락을 없애라

accountAddress와 customAddress는 Address 클래스 인스턴스로는 좋은 예시

클래스 이름으로는 좋지 않은 예시 (클래스 이름은 accountAddress 보단 Address가 더 좋다)

 

오늘 읽은 소감

변수 이름을 지을 때 이렇게 고려해야 할 사항이 많다니... 놀라웠다...

기존 프로젝트의 변수 이름은 틈날때 마다 바꿔줘야겠다.

 

 

궁금하거나 잘 이해되지 않는 내용

없음.