컨벤션-구글 자바 스타일

 

패키지 이름	소문자, 숫자만 사용해서 단어를 이어붙인다.	deepspace
클래스 이름	UpperCamelCase 사용한다. 주로 명사/명사구 사용	CarRace
메서드 이름	lowerCamelCase, 주로 동사/동사구 사용	sumPosition
상수 이름	UPPER_SNAKE_CASE, 불변 객체만 상수로 취급한다. static final	MAX_POINT
필드(인스턴스),로컬,매개변수 이름	lowerCamelCase	studyFirst
클래스 변수	lowerCamelCase	totalAccount
타입 변수	단일 대문자 또는 클래스명 + T	requestT

 

클래스 내 위치 컨벤션

class  T {
    상수(static final) 또는 클래스 변수
    인스턴스 변수
    생성자
    팩토리 메소드
    메소드
    기본 메소드 (equals, hashCode, toString)
}

 

 

 

식별자

• 개발자가 임의로 만들어서 사용하는 고유한 이름
• 아스키문자와 숫자만 사용하고, 특정 경우에만 밑줄 허용한다.
• 식별자 이름에 특수 접두사, 접미사 미허용. ex : name_,mname 등

 

패키지 이름

• 소문자와 숫자만 사용한다.
• 단어를 구분하기 위해 _사용하지 말고 이어 붙인다. ex: deep_space나 deepSpace대신 deepspace

클래스 이름

• 클래스 이름은 UpperCamelCase로 작성한다. (각단어의 첫글자만 대문자, 나머지 소문자. 띄어쓰기나 구분자없이 단어를 이어붙인다.)
• 주로 명사나 명사구로 이름을 짓는다. Character
• 테스트 클래스는 보통 Test로 끝난다.

메서드 이름

• 메서드 이름은 lowerCamelCase로 작성한다.(UpperCamelCase에서 첫글자만 소문자로 하는 것)
• 주로 동사나 동사구 사용
• JUnit 테스트 메서드 이름은 논리적 구성 요소를 밑줄로 구분할 수 있다.

 

상수 이름

• UPPER_SNAKE_CASE로 작성한다.(모든 글자 대문자 및 단어는 밑줄로 구분)
• 상수는 static final 필드이고, 값이 변경되지 않는 객체여야 한다.
  • static final int NUMBER =5;
• 가변객체나 단순히 변경하지 않기로 한 객체는 상수가 아니다.
  • static final Set<String> mutableCollection = new HashSet<String>(); (상수가 아님) set의 요소들은 변경이 가능하다.

상수가 아닌 필드의 이름

• lowerCamelCase로 작성한다.
• 명사나 명사구로 이름 짓기 index 

매개변수 이름

• lowerCamelCase 작성하기
• 한글자 매개변수 이름 피하기

로컬 변수 이름 

• 메서드 내부에서 선언되고, 해당 메서드가 실행되는 동안만 존재하는 변수
• lowerCamelCase로 작성.
• 로컬변수가 final 및 불변이더라도 상수처럼 작성하지 않는다.

 

타입 변수 이름

• 2가지중 1가지 스타일로 작성한다.
  • 단일 대문자(E,T등)
  • 클래스 명명 방식(UpperCamelCase)에 T를 덧붙인 이름(requestT)

 

카멜 케이스 정의

• 영어 구문을 변환하여 일관성있게 사용할 수 있도록 규칙을 따른다.
• 영어 문구를 아스키로 변환하고 구두점 제거후, 단어를 분리해서 처리한다.
• 소문자로 변환후, UpperCamelCase또는 lowerCamelCase로 단어를 변환한다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Google Java Style Guide

Code Conventions for the Java Programming Language: 3. File Organization