의미 있는 이름

이진호·2022년 10월 20일
0

Clean Code

목록 보기
1/1
post-thumbnail

2. 의미 있는 이름

의도를 분명히 밝혀라

주석이 필요하다면 의도를 분명히 드러내지 못했다는 말.
의도가 드러나는 이름을 사용하면 코드 이해와 변경이 쉬워진다.

그릇된 정보를 피하라

그릇된 단서는 코드의 의미를 흐린다.
유사한 개념은 유사한 표기법을 사용.
일관성이 떨어지는 표기법은 그릇된 정보.

의미 있게 구분하라

컴파일러를 통과할지라도 연속된 숫자를 덧붙이거나 불용어(noice word)를 추가하는 방식은 적절하지 못하다.

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

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

문자 하나를 사용하는 이름과 상수는 텍스트 코드에서 쉽게 눈에 띄지 않는다는 문제점이 있다.
이름 길이는 범위 크기에 비례해야 한다.

인코딩을 피하라

유형이나 범위정보까지 인코딩에 넣으면 그만큼 이름을 해독하기 어려워진다.
헝가리식 표기법 - 요즘 나오는 프로그래밍 언어는 IDE와 컴파일러가 타입을 점검하므로 불필요.
멤버 변수 접두어 - 코드를 읽을수록 접두어는 관심 밖으로 밀림.
인터페이스 클래스와 구현 클래스 - 인코딩이 필요한 경우, 인터페이스 클래스 대신 구현 클래스를 인코딩 하는 편이 좋음.

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

명료함이 최고

클래스 이름

클래스 이름과 객체 이름은 명사나 명사구가 적합하다.
Manager, Processor, Data, Info 등과 같은 불용어 단어는 피하고, 동사는 사용하지 않는다.

메서드 이름

메서드 이름은 동사나 동사구가 적합하다.
접근자(Accessor), 변경자(Mutator), 조건자(Predicate)는 javabean 표준에 따라 값 앞에 get, set, is를 붙인다.

기발한 이름은 피하라

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

똑같은 메서드를 클래스마다 fetch, retrieve, get으로 제각각 부르면 혼란스럽다.

말장난을 하지 마라

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

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

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

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

문제 영역 개념과 관련이 깊은 코드라면 문제 영역에서 이름을 가져와야 한다.

의미 있는 맥락을 추가하라

클래스, 함수, 이름 공간에 넣어 맥락을 부여하고, 그 방법조차 안되면 마지막 수단으로 접두어를 붙인다.

불필요한 맥락을 없애라

일반적으로 짧은 이름이 긴 이름보다 좋다. 단, 의미가 분명한 경우에 한해서다.

출처

0개의 댓글