Java Naming Convention

본 포스팅은 개발하는 주디씨 블로그의 글을 참고하여 작성하였습니다.

[Java] 프로젝트, 패키지, 메소드, 클래스 네이밍 규칙

 

공통 

• 대소문자가 구분되며 길이에 제한이 없다.
• 예약서 사용 X
• 숫자로 시작하면 안된다.
• 특수문자는 '_' 또는 '$'만 사용 가능하다.
• 반의어는 반드시 대응하는 개념으로 사용해야 한다.

 

Project 프로젝트

• 대/소문자 구분 없이 시작 가능하다.
• 대문자 사용을 권장한다.

 

Class 클래스

• 명사로 작성한다.
• 대문자로 시작한다.
• Pascal Case를 사용한다. ➡️ 여러 개의 단어를 조합하여 작성하는 경우 각 단어의 첫 번째 글자는 대문자로 한다.

class Cake() {}
class BananaCake() {}

 

Interface 인터페이스

• Pascal Case를 사용한다.
• 형용사를 사용한다.

 

Method 메서드

• 동사로 작성한다.
• 소문자로 시작한다.
• Camel Case를 사용한다. ➡️ 여러 개의 단어를 조합하여 만들 경우 맨 첫 글자를 제외한 나머지 단어의 첫 글자는 대문자를 사용하여 구분한다.

eat();
eatCake();
getPrice();

 

1. 속성에 접근하는 메서드 명의 접두사는 "set" , "get"을 사용한다.
2. 데이터를 조회하는 메서드 명은 접두사 find를 사용한다.
3. 데이터를 입력하는 메서드 명의 접두사는 input을 사용한다.
4. 데이터를 삭제하는 메서드 명의 접두사는 delete를 사용한다.
5. 데이터를 초기화하는 메서드 명의 접두사는 initialize를 사용한다.
6. 반환 값의 타입이 boolean인 메서드의 접두사는 is를 사용한다.
7. 데이터를 불러오는 메서드의 명은 접두사 laod를 사용한다.
8. 데이터가 있는지 확인하는 메서드명의 접두사는 has를 사용한다.
9. 새로운 객체를 만든 뒤 해당 객체를 리턴해주는 메서드 명의 접두사는 create를 사용한다.
10. 해당 객체를 다른 형태의 객체로 변환해주는 메서드 명의 접두사는 to를 사용한다.
11. 해당 객체가 복수인지 단일인지 구분하는 메서드의 접미사는 s를 사용한다.
12. B를 기준으로 A를 하겠다는 메소드명의 전치하는 By를 사용한다.

 

Package 패키지

• 패키지명은 대소문자 모두를 허용하지만 소문자로 하는 것을 원칙으로 한다.
• 표준 패턴을 따른다. 
  • ex) [com].[Company].[Project].[toppackage].[lowerpackage]
• 가급적 한 단어 사용을 권장한다.

 

Variable 변수

• 소문자로 시작한다.
• Camel Case를 사용한다.
• 의미가 있는 이름으로 작성하여 변수명만 봐도 사용한 이유를 알 수 있게 지어야 한다.
• 순서를 의미하고 임시로 쓰이는 정수의 변수명은 i, j, k, m, n을 사용한다. 문자의 경우 c, d, e등을 사용한다.
• 변수명에 _, $를 사용할 수 있자만 시작 문자로 사용하는 것은 지양한다.

String userName;
int userAge;
int i ; // 주로 반복문에서 사용한다.
char c; // 주로 반복문에서 사용한다.

 

Constant 상수

• 전부 대문자로 작성한다.
• Snake Case를 사용하여 '_'로 구분한다.

int MAX_DEPTH = 100;
int MIN_DEPTH = 1;