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

철자 규칙

• 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룸
• 특별한 이유가 없는 한 따라야함 → 어기면 코드를 읽기 어렵고 유지보수하기 어려움

 

1) 패키지와 모듈

• 각 요소를 점(.)으로 구분하여 계층적으로 짓기
• 요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이루어짐
• 조직의 인터넷 도메인 이름을 역순으로 사용 ex) com.google, org.eff
  • 예외로 표준 라이브러리는 java, 선택 패키지들은 javax로 시작
• 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이루어짐
  • 각 요소는 8자 이하의 짧은 단어로 (한 단어 혹은 약어)

 

2) 클래스와 인터페이스

• 하나 이상의 단어로 이루어짐, 각 단어는 대문자로 시작 ex) List
• 여러 단어의 첫글자만 딴 약자나 max,min 처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 사용하지말자.
  • 약자는 첫글자만 대문자로 ex) HttpUrl

 

3) 메서드와 필드

• Camel Case : 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명 규칙과 같음 ex) ensureCapacity
• 첫 단어가 약자라면 단어 전체가 소문자여야함
• 상수 필드는 모두 대문자로 쓰고 단어 사이는 밑줄(_)로 구분 ex) NEGATIVE_INFINITY
  • 상수 필드는 값이 불변인 static final

 

4) 지역 변수

• 다른 멤버와 비슷한 명명 규칙. 단, 약어를 써도 좋음
• 입력 매개변수도 지역 변수 → 일반 지역변수보다는 신경 써야함

 

5) 타입 매개변수

• 보통 한문자로 표현
  • T : 임의의 타입
  • E : 컬렉션 원소의 타입
  • K : 맵의 키, V : 맵의 값
  • X : 예외
  • R : 메서드의 반환 타입

 

 

문법 규칙

1) 객체를 생성할 수 있는 클래스 (Enum 포함)

• 이름은 보통 단수 명사나 명사구를 사용 ex) Thread, PriorityQueue
• 객체를 생성할 수 없는 클래스 [아이템 4] 의 이름은 보통 복수형 명사로 지음 ex) Collections, Collectors

 

2) 인터페이스

• 클래스와 똑같이 짓거나 able 혹은 ible 로 끝나는 형용사로 지음 ex) Runnable, Accessible

 

3) 애너테이션

• 규칙이 따로 없어 명사, 동사, 전치사, 형용사가 두루 쓰임 ex) Singleton, Inject

 

4) 메서드

• 동사나 목적어를 포함한 동사구 ex) append, drawImage
• boolean 반환 메서드라면 보통 is나 드물게 has로 시작하고 명사나 명사구, 형용사로 기능하는 아무 단어나 구로 끝나도록 지음 ex) isDigit, isEnabled
• boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드 이름은 보통 명사, 명사구, get으로 시작하는 동사구로 지음 ex) size, hashCode, getTime
• 객체의 타입을 바꿔서 다른 타입의 또 다른 객체를 반환하는 인스턴스의 메서드 : toType 형태 ex) toString, toArray
• 객체의 내용을 다른 뷰로 보여주는 메서드 [아이템 6] : asType 형태 ex) asList
• 객체의 값을 기본 타입 값으로 반환하는 메서드 : typeValue 형태 ex) intValue
• 정적 팩터리 : from, of, valueOf, instance, getInstance, newInstance, getType, newType [아이템 1] 을 흔히 사용

 

5) 필드

• 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요 (잘 설계된 API는 필드가 직접 노출되지 않기 때문)
• boolean 타입 필드 이름 : boolean 접근자 메서드에서 앞 단어를 뺀 형태 ex) initialized, composite
• boolean 이 아닌 필드 이름 : 명사나 명사구 사용 ex) height, digits, bodyStyle
• 지역변수 이름 : 비슷하지만 더 느슨함

 

 

결론

• 표준 명명 규칙을 체화하여 베어나오도록 하자
• 철자 규칙은 직관적인 데 비해 문법 규칙은 더 복잡하고 느슨함
• 오랫동안 따라온 규칙과 충돌한다면 그 규칙을 맹종해서는 안된다.