카테고리 없음

20240808 개발 공부 ( Java Code Conventions - 이름 )

llmmhh 2024. 8. 8. 20:40

자바 코딩 컨벤션 에 대해 알아보자.

컨벤션에 따라서 작성할 때 내가 작성한 코드의 가독성이 좋아진다고 한다!! (읽고 이해하기 편해짐)

 

이름

변수명,클래스명,메서드 명에는 영어/숫자/언더스코어( _ ) 만 사용한다.

 

1. 발음이 아닌 뜻에 따라 이름을 작성한다.

예를 들어 한국을 이름으로 하려면

hangug = X

korea = O 라고 쓴다.

 

2. 클래스 이름은 단어의 첫 글자를 대문자로 쓴다. 대문자 카멜표기법 ( Upper camel case ) 라고 한다.

맨 앞 글자 뿐만 아니라 단어의 첫 글자는 모두 대문자.

Class newpost = x

Class NewPost = O 예시가 적절할지 모르겠지만 이런 느낌이다.

 

3.테스트 클래스는 뒤에 Test 를 붙인다.

NewPostTest 이런식으로!!

 

4.메서드의 이름, 변수는 소문자로 표기한다.

int number;  이런식으로!!

 

5. 메서드의 이름은 동사/전치사로 시작한다.

동사

numberAdd() = X

Addnumber() = O 이런식으로 행동이 앞으로 온다!!

전치사 (예시로 전환 메서드)

Stringto() = X

toString() = O

 

6. 상수는 대문자와 언더스코어로 구분한다.

static final 이 선언되어 있으면 상수로 간주.

상수는 대문자!

public final int CODE = 1111;

복합어는 언더스코어 ' _ ' 를 사용해서 구분한다.

public final int USA_COUNTRY_CODE = 1;

public final int KOREA_COUNTRY_CODE = 82;

 

7. 임시로 만든 변수가 아니면 최소 2글자 이상으로 작성한다.

int a;  = X

int num; = O