item 68 leekyunghee - JAVA-JIKIMI/EFFECTIVE-JAVA3 GitHub Wiki

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

코드의 가독성, 의도를 파악하기 위함

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

• 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다. 요소들은 모두 소문자 알파벳

edu.cmu, com.google, org.eff 식으로 조직의 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다. 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다.

• 도메인 이름을 패키지 이름의 접두어로 변환하는 자세한 규칙은 자바 언어 명세 (JLS, 6.1) 참고

패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다.

• 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다

utilities 보다는 util처럼 의미가 통하는 약어를 추천한다.

• 인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만 많은 기능을 제공하는 경우엔 계층을 나눠 더 많은 요소로 구성해도 좋다.
• 예를 들어 java.util은 java.util.concurrent.atomic과 같이 그 밑에 수많은 패키지를 가지고 있다.
• 자바가 패키지 계층에 관해 언어 차원에서 지원하는 건 거의 없지만 어쨌든 이처럼 하부의 패키지를 하위 패키지라 부른다.

(열거 타입과 애너테이션을 포함해) 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.

• (List, FutherTask 등) 여러 단어의 첫글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다.

메서드와 필드 이름은 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명 규칙과 같다.(remove, ensureCapacity) 등

• 첫 단어가 약자라면 단어 전체가 소문자여야 한다.

상수 필드는 예외

• 상수 필드는 값이 불변인 static final 필드를 말한다.
• 상수 필드를 구성하는 단어는 모두 대문자로 단어 사이는 밑줄로 구분한다. (VALUES, NEGATIVE_INFINITY) 등

지역변수에도 다른 멤버와 비슷한 명명 규칙이 적용된다.

• 단 약어를 써도 좋다.
• 약어를 써도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있기 때문이다.
• 입력 매개변수도 지역변수의 하나 하지만 메서드 설명 문서에까지 등장하는 만큼 일반 지역변수 보다는 신경을 써야한다.

타입 매개변수 이름은 보통 한 문자로 표현한다.

대부분은 다음의 다섯가지 중 하나다

임의의 타입엔 T, 컬렉션 원소의 타입은 E, 맵의 키와 값에는 K,V, 메서드의 반환 타입에는 R을 사용한다.

객체를 생성할 수 있는 클래스(열거 타입 포함)의 이름은 보통 단수 명사나 명사구를 사용한다. (Thread, PriorityQueue, ChessPiece 등)

객체를 생성할 수 없는 클래스(아이템 4) 보통 복수형 명사로 짓는다. (Collectors, Collections 등)

인터페이스 이름은 클래스와 똑같이 짓거나 (Collection, Comparator 등) able, ible로 끝나는 형용사로 짓는다. (Runnable, Iterable, Accessible)

애너테이션은 워낙 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다. (BindingAnnotation, Inject, ImplementedBy, Singleton 등)

어떤 동작을 수행하는 메서드의 이름은 동사나 (목적어를 포함한) 동사구로 짓는다 (append, drawImage)

• boolean 값을 반환하는 메서드라면 보통 is나 has로 시작하고 명사나 명사구 혹은 형용사로 가능하는 아무 단어나 구로 끝나도록 짓는다.

isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings 등)

반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다. (size, hasCode, getTime 등)

세번째 형식, 즉 get으로 시작하는 형태만 써야 한다는 주장도 있지만 근거가 빈약

---

• 관례처럼 사용하고 특별한 메서드 이름을 가지는 몇가지

아이템 6, 객체의 타입을 바꿔서 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType, toString, toArray 등

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

아이템 1, 정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType