[Item 68] 일반적으로 통용되는 명명 규칙을 따르라

철자 규칙은?

철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.

 

- 패키지와 모듈명은 각 요소를 점(.)으로 이으며 계층적으로 짓는다. 

모두 소문자 혹은 숫자로 지어야 한다. 도메인이 있다면 역순으로 사용한다. 예컨대 com.google, org.eff, edu.cmu 식이다.

 

패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이루어진다. 각 요소는 8자 이하의 짧은 단어로 한다. utilities 보다는 util 같은 약어를 추천한다. 

또한, 여러 단어로 구성된 이름이라면 awt처럼 각 단어의 첫 글자만 따서 사용한다.

 

- 클래스와 인터페이스 이름은 대문자로 시작하며 줄여 쓰지 않도록 한다. 

대표적인 첫 글자만 딴 약자는 max, min이 있는데, 이처럼 널리 통용되는 줄임말을 제외하고는 줄이지 말아야 한다. 

 

약자의 경우라도 첫글자만 대문자로 하는 것을 권장한다.

예를 들어 HttpUrl처럼 여러 약자가 혼합된 경우라도 그 시작과 끝을 명확히 알 수 있기 때문이다. (HTTPURL과 비교)

 

- 메서드와 필드명은 첫 글자를 소문자로 쓴다. 

단, 예외로 상수 필드는 모두 대문자로 쓰며 단어 사이는 밑줄(_)로 구분한다. VALUES, NEGATIVE_INFINITY 등이다. 이름에 밑줄을 사용하는 요소로는 상수 필드가 유일하다는 사실을 기억하자.

 

지역변수에도 비슷한 명명규칙이 적용된다. 단, 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있으므로 약어를 써도 좋다.

 

- 타입 매개변수명은 한 문자로 표현한다. 

일반적으로 다음과 같이 쓴다.

 

T : 임의의 타입. Type의 약자

E : 컬렉션의 원소. Element의 약자

K, V : Map의 키와 값. Key와 Value의 약자

X : 예외. Exception의 약자

R : 메서드의 반환 타입. Return의 약자

 

그 외의 임의 타입의 시퀀스에는 T, U, V 혹은 T1, T2, T3를 사용한다.

 

식별자 타입	예
패키지와 모듈	org.juit,.jupiter.api.com.google.common.collect
클래스와 인터페이스	Stream, FutureTask, LinkedHashMap, HttpClient
메서드와 필드	remove, groupingBy, getCrc
상수 필드	MIN_VALUE, NEGATIVE_INFINITY
지역변수	i, denom, houseNum
타입 매개변수	T, E, K, V, X, R, U, V, T1, T2

 

문법 규칙

문법 규칙은 논쟁의 소지가 있을 수 있으며, 유연하다. 

규칙은 다음과 같다.

• 객체를 생성할 수 있는 클래스명은 보통 명사, 명사구를 사용한다.
  • ex) Thread, PriorityQueue, ChessPiece
• 객체를 생성할 수 없는 클래스명은 보통 복수형 명사로 짓거나 형용사로 짓는다.
  • ex) Collectors나 Collections
• 인터페이스 이름은 클래스와 똑같이 짓거나, able 혹은 ible로 끝나는 형용사로 짓는다
  • ex) Runnable, Iterable, Acessible
• 애너테이션은 지배적인 규칙 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다.
  • ex) BindingAnnotation, Inject, ImplementedBy, Singleton 
• 메서드명은 동사, 동사구로 짓는다.
  • ex) append, drawImage 
• boolean 값을 반환하는 메서드라면 보통 is나 드물게 has로 시작하고, 명사, 명사구, 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다.
  • ex) isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings 
• 해당 인스턴스의 속성을 반환하는 메서드는 명사 또는 명사구, get으로 시작하는 동사구로 짓는다. (boolean 제외)
  • ex) size, hashCode, getTime
• 객체의 타입을 바꿔서 다른 타입의 또 다른 객체를 반환하는 메소드는 보통 to타입 형태로 짓는다.
  • ex) toString, toArray, toPath 
• 객체의 내용을 다른 뷰로 보여주는 메소드는 as타입 형태로 짓는다.
  • ex) asList 
• 객체의 값을 기본 타입 값으로 반환하는 메서드는 타입 Value 형태로 짓는다.
  • ex) intValue 
• 정적 팩토리의 이름은 다양하지만 from, of, valueOf, instance, getInstance , newInstance , getType, newType을 사용한다.
• 필드 이름에 관한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 중요하다. 필드가 직접 노출될 일이 적기 때문이다. 
• boolean 타입의 필드 이름은 보통 boolean 접근자 메서드에서 앞 단어를 뺀 형태다
  • ex) initialized, composite 
• 다른 타입의 필드라면 명사나 명사구를 사용한다.
  • ex) height, digits, bodyStyle 
• 지역변수 이름도 필드와 비슷하게 지으면 되나 조금 더 느슨하다.

 

---

핵심정리

• 표준 명명 규칙을 체화하자

---

참조자료

www.kyobobook.co.kr/product/detailViewKor.laf?ejkGb=KOR&mallGb=KOR&barcode=9788966262281&orderClick=LEa&Kc=

이펙티브 자바 3/E - 교보문고