이펙티브 자바 item 68) 일반적으로 통용되는 명명 규칙을 따르라

철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드 타입 변수의 이름을 다루는데 이 규칙들은 특별한 이유가 없는 한 반드시 따라야 한다.

 

👉 패키지와 모듈

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

조직 바깥에서도 사용될 패키지라면 조직 인터넷 도메인 이름을 역순으로 사용한다.

ex) com.google 

예외적으로 표준 라이브러리와 선택적 패키지들은 java와 javax로 시작함 

패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄지는데 각 요소는 일반적으로 8자 이하의 짧은 단어로 함

ex) utilities 보다는 util 처럼 의미가 통하는 약어를 추천'

여러 단어가 포함된 이름이라면 awt 처럼 각 단어의 첫 글자만 따서 써도 좋음 

 요소의 이름은 보통 한 단어 혹은 약어로 이뤄짐 

😳클래스 이름은 축약을 사용하지말라~ 하는데 패키지 + 모듈은 약어를 사용하는 게 규칙이구나~ 를 알게 됨 

 

👉 클래스와 인터페이스 

하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작함 

여러 단어의 첫 글자만 딴 약자나 max,min 처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 x 

객체를 생성할 수 있는 클래스의 이름은 보통 단수 명사나 명사구를 사용 

객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓는다 (ex)Collectors,Collections

인터페이스 이름은 클래스와 똑같이 짓거나 , able or ible로 끝나는 형용사로 짓는다.

애너테이션은 워낙 다양하게 활용되어 지배적인 규칙 x 즉 명사, 동사, 전치사, 형용사가 두루 쓰임

 

👉 메서드와 필드 이름 

첫 글자를 소문자로 쓴다는 점만 제외하고는 클래스 명명 규칙과 동일하다

단, 상수 필드는 예외

-> 상수 필드는 단어 모두 대문자로 쓰며 단어 사이는 밑줄로 구분 , 이름에 밑줄을 사용하는 것은 상수 필드가 유일하다 

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

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

반환 타입이 boolean이 아니거나 인스턴스의 속성을 반환하는 메서드라면 보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다.

 

객체의 타입을 바꿔서 다른 타입의 또 다른 객체를 반환하는 메서드의 이름은 보통 toType 형태로 짓는다(ex) toString

정적 팩토리의 이름은 다양하지만 아이템 1에서 알려준 네이밍을 쓴다.

필드의 이름은 보통 직접 노출될 일이 없기 때문에 메서드 이름에 비해 덜 명확하고 덜 중요하다. 

 

👉지역변수

다른 멤버와 비슷한 명명 규칙이 적용되는데 단, 약어를 써도 된다.

써도 되는 이유는 사용되는 문맥에서 의미를 쉽게 유추할 수 있기 때문

매개변수도 지역변수 중 하나지만 매개변수는 메서드 설명 문서에 등장하는 만큼 일반 지역변수보단 신경을 써야 한다. 

-> 매개변수에는.. 약어를 안 쓰는 게 좋을 거 같다.

 

👉 타입 매개변수 

보통 한 문자로 표현하는데 대부분은 다섯 가지 중 하나

1) 임의의 타입 : T

2) 컬렉션 원소의 타입은 : E

3) 맵의 키와 값에는 K와 V

4) 예외에는 X 

5) 메서드 타입에는 R 

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