자바 공부를 시작하면서 기본적인 명명법에 대해서 찾아봤다.

명명법

목적: 가독성 향상, 코드 이해와 유지 관리, 품질 향상

• 패키지: 소문자로만 구성
• 자료형: 명사, 파스칼 케이스
• 변수: 카멜 케이스
• 상수: 대문자로만 구성, 스네이크 케이스
• 메서드: 카멜 케이스, 동사

기타1

• 약어 사용시 첫 문자만 대문자: 가독성
• private 클래스 변수는 접미'_' 사용: 범위 표시
  • ex - private String name_;
• 일반적인 변수는 타입과 같은 이름 사용
  • ex - setTopic(Topic topic)
  • cf - Point startingPoint, endPoint
• 스크래치 변수는 짧게 명명하여, 바깥 범위에서 사용하지 않음을 추측가능하도록
  • 정수: i, j, k, m, n
  • 문자: c, d
• 메서드 이름에 객체 이름 표현 X: 중복
  • ex - line.getLength(); // x - line.getLineLength();

기타2

• 접두
  • get/set: 변수 직접 접근
  • is: boolean 변수와 메서드
  • has, can, should
  • compute: 계산
  • find: 탐색
  • initialize: 초기화
    • x - init
  • n: 개수
    • ex - nPoints
  • Default: 디폴트 인터페이스
  • new: 인스턴스를 생성하는 메서드
    • ex - newPoint();
• 접미
  • No: 번호
    • ex - employeeNo
• 사용자 인터페이스 컴포넌트 이름에 접미에 요소 타입
• collection이나 배열 타입의 변수는 복수형태로 작성
• 반복자 변수로 i, j, k 사용
• boolean 타입 변수 이름에 부정적 의미 X
• 관련있는 상수 앞에 공통 단어
  • final int COLOR_RED = 1; final int COLOR_GREEN = 2; final int COLOR_BLUE = 3;
• 예외 클래스는 클래스 뒤에 Exception 키워드
• 싱글톤 패턴을 구현한 클래스에서 인스턴스를 반환하는 메서드 이름 getInstance()
  • cf - get(), instance() X
• 객체를 반환하는 메서드는 무엇을 반환하는지로 명명
• 프로시저(void형 메서드)는 무엇을 하는지로 명명

출처: http://fluxens.com/javastyle.html#General_Recommendations