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

• 자바 플랫폼은 명명 규칙이 잘 정립되어 있으며, 그중 많은 것이 자바 언어 명세에 기술되어 있다.
• 자바의 명명 규칙은 크게 철자와 문법 두 범주로 나뉜다.

 

 

철자 규칙

• 패키지, 클래스, 인터페이스, 메소드, 필드, 타입 변수의 이름을 다룬다.
• 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
• 요소들은 모두 소문자 알파벳 혹은 숫자로 이루어진다.
• 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다.
• 짧은 단어를 추천한다.
  • utilities 보다는 util
• 여러 단어로 구성되어 있다면 awt처럼 첫 글자만 따서 써도 좋다.

• 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.
• 단어를 웬만해서는 줄여쓰지 않는다.
• 메소드와 필드 이름은 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명규칙과 같다.

• 단, 상수 필드는 모두 대문자로 쓴다.

• 지역변수에도 다른 멤버와 비슷한 명명규칙이 적용된다. 단, 약어를 써도 좋다.
• 타입 매개변수 이름은 보통 한 문자로 표현한다.
  • 임의의 타입 T
  • 컬렉션 원소의 타입 E
  • 맵의 키와 값 K, V
  • 예외 X
  • 메소드 반환 타입 R

식별자 타입

패키지와 모듈	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

 

 

문법규칙

• 철자 규칙과 비교하면 더 유연하고 논란도 많다.

• 객체를 생성할 수 있는 클래스의 이름은 보통 단수 명사나 명사구를 사용
  • Thread, PriorityQueue 등
• 객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사
  • Collectors, Collections
• 인터페이스 이름은 클래스와 똑같이 짓거나 able, ible로 끝나는 형용사
  • Runnable, Iterable

• 어노테이션은 다양하게 사용됨

• 어떤 동작을 수행하는 메소드의 이름은 동사나 동사구로 짓는다
  • append, drawImage

• boolean 값을 반환하는 메소드라면 is나 has로 시작
  • isDigit, isProbablePrime, isEmpty, isEnabled

• 반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메소드의 이름은 보통 명사, 명사구 혹은 get으로 시작하는 동사구
  • size, hashCode, getTime

• 객체의 타입을 바꿔서 다른 타입의 또 다른 객체를 반환하는 인스턴스 메소드의 이름은 보통 toType의형태
  • toString, toArray

• 객체의 내용을 다른 뷰로 보여주는 메소드의 이름은 asType
  • asList

• 객체의 값을 기본 타입 값으로 반환하는 메소드의 이름은 보통 typeValue
• -intValue