JAVA/Effective Java

규칙 56 - 일반적으로 통용되는 작명 관습을 따르라

반응형

자바의 작명관습은 두 가지 범주로 나눌 수 있다.

철자.
-> 패키지, 클래스, 인터페이스, 메서드, 필드 그리고 자료형 변수에 관한 것
-> 아주 그럴듯한 이유가 없이 이 규칙을 어겨서는 안 된다.

1). 패키지
-> 마침표를 구분점으로 사용하는 계층적 이름 이어야 한다.
-> 각각의 컴포넌트는 알파벳 소문자로 구성하고, 숫자는 거의 사용하면 안된다.
-> 패키지 시작은 회사 조직의 도메인으로 시작한다. com.wedul
-> 패키지명 컴포넌트는 짧아야 하며, 8자리 이하여야 한다.
-> 약어를 사용하여 의미를 충분히 전달할 수 있어야한다.

2). 클래스, 인터페이스, Enum
-> 하나이상의 단어로 구성된다.
-> 각 첫 글자는 대문자로 시작해야 하며 널리 사용 되는 약어를 제외하고는 약어를 사용해서는 안된다.
-> 단어의 첫 글자만 대문자로 사용하는 것이 좋다.

3). 메서드와 필드
-> 메서드와 필드도 클래스와 인터페이스와 동일한 규칙을 따르지만, 소문자로 시작한다.
-> 상수 필드는 하나 이상의 대문자로 구성되며 단어 마다 _로 구분한다. VALUE_FIELD 
-> 지역 필드에 경우 약어로 사용해도 무관하다. (ex. i, xref..)


문법.
-> 철자 규칙보다는 덜 속박받는 규칙으로 사용된다. (의견이 분분하기 때문에 알맞게 사용하면 된다.)

1) 클래스, enum
-> 명사나, 명사구를 사용한다. 
-> 클래스에 경우 형용사구를 사용하는 경우가 있다. Runnable, Iterable 등등..

2) 메서드
-> 일반적으로 동사, 동사구를 사용하ㅓㄴ다. append 

3) boolean
-> is, has로 시작하여 사용한다.



요약하면, 표준적 작명 관습을 숙지하고 사용하라. 
잘 작성된 명명 규칙만으로도 개발자들 사이에서는 백마디 말보다 더 빠른 이해력을 도울 수 있다. 

출처 : 조슈아 블로크, 『 Effective Java 2/E』, 이병준 옮김, 인사이트(2014.9.1), 규칙56 인용.

반응형