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

2025. 2. 20. 21:20

자바의 명명 규칙은 크게 철자, 문법 두 범주로 나뉜다.

 

철자

1. 패키지와 모듈 이름은 각 요소를 점으로 구분하여 계층적으로 짓는다.  요소들은 모두 소문자 알파벳 혹은 (드물게) 숫자로 이뤄진다. 조직 바깥에서도 사용될 패키지라면 조직의 dns 이름을 역순으로 사용한다.(예시: com.google) 

2. 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다. 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다.

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

4. 상수 필드는 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다. (NEGETIVE_INFINITY)

5. 지역변수에서도 다른 멤버와 비슷한 명명 규칙이 적용된다. 하지만 문맥이 추론 가능하다면 약어를 써도 된다.

6. 타입 매개변수 이름은 보통 한 문자로 표현한다. T = 임의의 타입, E = 컬렉션 원소의 타입, K와 V = 맵의 키와 값, X = 예외, R = 메서드 반환 타입, 그 외의 임의 타입의 시퀀스는 T, U, V 혹은 T1, T2, T3을 사용한다.

 

문법

1. 객체 생성이 가능한 클래스의 이름은 보통 단수 명사나 명사구를 사용한다. 생성이 불가능한 클래스는 보통 복수형 명사로 짓거나 able 혹은 ible로 끝나는 형용사로 짓는다. 애너테이션은 지배적인 규칙 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다.

2. 동작을 수행하는 메서드의 이름은 동사나 동사구로 짓는다. boolean 값을 반환하는 메서드는 보통 is나 has로 시작하고 명사나 명사구, 혹은 형용사로 기능하는 아무 다너나 구로 끝나도록 짓는다.

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

4. 객체의 타입을 바꿔서, 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다.(toString, toArray 등) 객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType으로 짓는다.(asArray) 객체의 값을 기본 타입 값으로 반환하는 메서드의 이름은 보통 typeValue로 짓는다. 정적 팩터리의 이름은 from, of, valueOf, instance, getType 등을 흔히 사용한다.

5. 필드 이름에 관한 문법 규칙은 덜 중요하다. API 설계를 잘 했다면 필드가 직접 노출될 일이 거의 없기 때문이다.

 

 

자바 언어 명세 : 오랫동안 따라온 규칙과 충돌한다면 그 규칙을 맹종해서는 안된다.

BELATED ARTICLES

more