본문 바로가기

카테고리 없음

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

철자규칙

 

자바는 명명규칙이 잘 정립되어있고 크게 철자규칙과 문법규칙 두 범주로 나눌 수 있다. 여기서 철자규칙은 패키지, 모듈, 클래스, 인터페이스, 메소드, 필드, 타입 변수의 명명 규칙을 다룬다.

 

  • 패키지와 모듈 : 각 요소를 점(.)으로 구분하여 계측적으로 짓는다. 각 요소들은 대부분 알파벳 소문자로 이루어진다. 또 일반적으로 com.google.common과 같이 인터넷 도메인의 역순으로 시작한다.
  • 클래스와 인터페이스 : 하나 이상의 단어로 이루어져있으며 각 단어는 대문자로 시작한다. 여러 단어가 합쳐진 경우 약자를 사용할 수 있는데, 이때도 약자의 시작만 대문자로 하는것이 일반적이다. ex) HttpUrl
  • 메소드와 필드 : 첫글자를 소문자로 시작하는것만 빼면 클래스/인터페이스 명명 규칙과 같다.
    • 상수필드: 상수필드의 경우 특별하게 각 단어를 모두 대문자로 쓰고 언더바로 단어사이를 구분한다. ex) EARTH_VOLUE
  • 타입변수 : 알파벳 대문자 하나로 표현한다. 임의의 타입엔 T, 컬렉션 타입은 E, 키와 값에는 K와 V, 예외에는 X, 반환 타입에는 R을 일반적으로 사용한다.

 

 


문법규칙

 

  • 클래스
    • 객체를 생성할 수 있는 클래스는 단수 명사나 명사구를 사용한다. ex) Thread, PrioprityQueue
    • 객체를 생성할 수 없는 클래스는 복수 명사를 사용한다. ex) Collections, Collections
  • 메소드
    • 동작을 수행하는 메소드는 동사나 동사구를 사용한다. ex) append, drawImage
    • boolean 값을 반환하는 경우 is나 has로 시작한다. ex) isDigit, hasSiblings
    • 인스턴스 속성을 반환하는 경우 명사, 명사구나 get을 사용한다. ex) hashCode, getName
    • 타입을 변환하여 반환하는 메소드의 경우 toType의 형태로 짖는다. ex) toString
728x90