도당탕탕

Item68 : 일반적인 네이밍 컨벤션을 따르라 본문

JAVA

Item68 : 일반적인 네이밍 컨벤션을 따르라

backlo 2023. 1. 19. 15:48

Java Language Specification (JLS, 6.1)에는 잘 만들어진 네이밍 컨벤션이 있다. 네이밍 컨벤션은 2가지 카테고리로 나눌 수 있다.

  • 활자관점에서의 컨벤션
    • 패키지의 모듈 이름은 계층 구조이어야 하고 점으로 구분되어야 함.
    • 클래스, 인터페이스에서 첫 번째 글자는 대문자 이어야 함.
    • 메서드와 필드이름의 첫 글자는 소문자 이어야 함.
    • 지역변수는 약어를 권장함.
    • Type 파라미터
      • T : any type
      • E : Element type
      • K, V : Key, Value type
      • X : exception type
      • R : return type
  • 문법관점에서의 컨벤션
    • 유연하고 논란의 여지가 있음.
    • 객체화 가능한 클래스는 명사나 명사구로 만듦.(Thread, PriorityQueue,...)
    • 객체화 안 되는 Util 클래스들은 복수로 표현(Collectors or Collections)
    • 인터페이스 : 클래스처럼 네이밍, 형용사로 끝낼 수 있음(Comparable).
    • 어노테이션 타입 : 명사, 동사, 전치사, 형용사 모두 가능
    • 메서드
      • 동사나 동사구로 사용됨.
      • boolean을 리턴하는 메서드는 is로 시작, has도 사용되기도 함.
      • 그밖에 등등...
    • 필드
      • 확실히 정해진 컨벤션 없음.

정리

표준 네이밍을 잘 사용하자.

Comments