[java] 명명 규칙

반의어

자주 사용하는 반의어	뜻
get / set (getter / setter)	받다 / 받다
add / remove	추가 / 제거
create / destroy	창조 / 파괴
start / stop	시작 / 정지
insert / delete	삽입 / 삭제
increment / decrement	증가 / 감소
old / new	구 / 신
begin / end	시작 / 끝
first / last	처음 / 마지막
up / down	위 / 아래
max / min	최대 / 최소
next / previous	다음 / 이전
open / close	열다 / 닫다
show / hide	보이다 / 숨기다
suspend / resume	일시정지 / 재개하다
parent / child	부모 / 자식

 

공통 명명 규칙

1. 대소문자 구분 및 길이에 제한이 없다.

2. 예약어를 사용해서는 안 된다.
ex)  break, catch, case , double, extends, if 등

3. 숫자로 시작해서는 안 된다.

4. 특수문자는 '_' 와 '$' 만을 허용한다.

5. 파스칼 표기법(PascalCase)과 카멜 표기법(camelCase)을 사용한다.

* PascalCase : 모든 단어에서 첫 번째 문자는 대문자이며 나머지는 소문자이다.
* camelCase : 최초에 사용된 단어를 제외한 첫 번째 문자가 대문자이며 나머지는 소문자이다.

6. 반의어는 반드시 대응하는 개념으로 사용해야 한다.

 

패키지(Package) 명명 규칙

1. 패키지명은 표준 패턴을 따라야 한다.
ex)  [com].[Company].[Project].[TopPackage].[LowerPackage]

2. 패키지명은 가급적 한 단어의 명사를 사용한다.
좋은 예 : com.nexon.sudden.member.object (O)
나쁜 예 : sudden.memberObject (X)

3. 패키지명은 보통 도메인명의 반대로 입력한다.
ex)  com.naver, net.daum

클래스(Class) 명명 규칙

1. 클래스명은 파스칼 표기법을 적용한다.
ex)  class HelloWorld,  class Student

2. 인터페이스에는 특별한 접두사나 접미사를 사용하지 않고 파스칼 표기법을 적용한다. 
ex)  interface Animal,  interface Bank

3. 인터페이스를 구현한 클래스에는 특별한 접두사나 접미사를 사용하지 않고 파스칼 표기법을 적용한다.
ex)  class Tiger implements animal

4. 추상 클래스에는 특별한 접두사나 접미사를 사용하지 않고 파스칼 표기법을 적용한다.
ex)  abstract class Animal,  abstract class Bank

 

메소드(Method) 명명 규칙

1. 메소드 명에는 파스칼 표기법을 적용한다.
ex)  void SendMessage(String message)

2. 속성에 접근하는 메소드 명의 접두사는 'get', 'set'을 사용한다.
ex)  void setDisplayName,
ex)  void getDisplayName
 
3. 데이터를 조회하는 메소드명의 접두사는 find를 사용한다.
ex)  void findData(String data)

4. 데이터를 입력하는 메소드명의 접두사는 input을 사용한다.
ex)  void inputData(HashMap data)

5. 데이터를 변경하는 메소드명의 접두사는 modify을 사용한다.
ex)  void modifyData(HashMap data)

6. 데이터를 삭제하는 메소드명의 접두사는 delete를 사용한다.
ex)  void delete Data(String data)

7. 데이터를 초기화 하는 메소드명의 접두사는 initialize를 사용한다.
ex)  void initData(String Data)

8. 반환값의 타입이 boolean인 메소드의 접두사는 is를 사용한다.
ex)  void isData(String Data)

9. 데이터를 불러오는 메소드명의 접두사는 load를 사용한다.
ex)  void loadData()

10. 데이터가 있는지 확인하는 메소드명의 접두사는 has를 사용한다.
ex)  void hasData()

11. 보다 지능적인 set이 요구될때 사용하는 메소드명의 접두사는 register를 사용한다.
ex)  void registerAccount()

12. 새로운 객체를 만든뒤 해당 객체를 리턴해주는 메소드명의 접두사는 create를 사용한다.
ex)  void createAccount()

13. 해당 객체를 다른 형태의 객체로 변환해주는 메소드명의 접두사는 to를 사용한다.
ex)  void toString()

14. 해당 객체가 복수인지 단일인지 구분하는 메서드명의 접미사는 s를 사용한다.
ex)  void getMembers()

15. B를 기준으로 A를 하겠다는 메소드명의 전치사는 By를 사용한다.
ex) void getUserByName(String name)

16. 반환값의 타입이 boolean인 메소드는 접두사로 is를 사용한다.
ex)  void isData(String Data)

17. 데이터를 불러오는 메소드명의 접두사는 load를 사용한다.
ex)  void loadData()

18. 데이터가 있는지 확인하는 메소드명의 접두사는 has를 사용한다.
ex) void hasData()

19. 보다 지능적인 set이 요구될때 사용하는 메소드명의 접두사는 register를 사용한다.
ex) void registerAccount()

20. 새로운 객체를 만든뒤 해당 객체를 리턴해주는 메소드명의 접두사는 create를 사용한다.
ex) void createAccount()

 

변수(Variable) 명명 규칙

1. 변수와 메소드의 파라미터에는 카멜표기법을 사용한다.
ex) int studentNumber,  int koreaAge

2. 변수는 약어사용을 지양하고 모든 의미를 충분히 담는다.

3. 한 글자로 된 이름을 사용하지 않는다
ex) int a,  int h

4. 선언된 지점에서 초기화하며, 가능한 사용범위를 최소화 한다.

5. 반복문에서 인덱스로 사용할 변수는 i, j ,k 등으로 한다.
ex) for(int i = 1;  i<=10; i++)

6. 지역변수와 멤버변수(전역변수)는 변수명 앞에 밑줄(_)을 사용하여 구별한다.

7. boolean타입의 변수는 접두사로 is를 사용한다
ex) boolean isCheck,  boolean isOk

 

상수(Constant) 명명 규칙

1. 전부 대문자로 지정한다.

2. 구분자로 '-' 을 사용한다 (스네이크케이스 명명 규칙에 따름)
ex) MAX_NUMBER,  MIN_NUMBER,  LIFESPAN