[Java] Code Convention(코드 컨벤션)

Code Convention

Code Conventions을 직역하면 "소스코드의 관습"입니다.

즉, 프로그래머 사이에서 약속한 코드 작성 양식인데 컴파일에러가 나는 문법 오류와 달리, 지키지 않아도 오류는 나지 않습니다.

 

Code Convention 왜 지켜야 할까?

우리가 개발을 혼자 담당한다면 내가 이해하기 편하면 그만입니다.

하지만 어떤 프로젝트에 대해서 내가 항상 관리하는 것은 불가능하고 다른 개발자가 소스 코드를 보았을 때 빠른 시간에 이해할 수 있는 코드가 좋은 코드라고 생각합니다.

그렇기 때문에 Code Convention을 지키게 되면 여러 명이 협업할 때 일관된 코드 스타일을 유지하며 가독성을 높이고 생산성을 증가시킬 수 있습니다.

 

Code Convention은 어떻게 지켜야 할까?

컨벤션은 프로그래머끼리의 약속이기 때문에, 내가 어디에 속해 있는지에 따라 달라집니다.

그렇지만 어느 정도 통용되는 가이드라인은 있을 것이며 우선 구글의 java code convention을 기반으로 공부해보고자 합니다.

다음은 가이드 링크입니다 https://google.github.io/styleguide/javaguide.html#s5-naminge

다음은 가이드 링크를 한국어로 정리해주신 블로그의 링크입니다 https://newwisdom.tistory.com/96

 

들어가 보면 여러 가지 가이드라인이 있는데 그중 이름을 어떻게 지으면 좋을지에 대한 Naming Convention에 대해 알아보고자 합니다.

 

Naming Convention

패키지의 이름이나, 클래스의 이름, 변수의 이름 등 어떻게 이름을 지었을 때 가독성을 높이기 위한 Convention이다.

 

패키지의 이름

모두 소문자로 이루어지며 연속된 단어는 단순히 연결됩니다.

 

옳은 예시

• com.example.deepspace

 

잘못된 예시

• com.example.deepSpace
• com.example.deep_space

 

클래스의 이름

클래스 이름은 UpperCamelCase로 작성됩니다.

 

클래스 이름은 일반적으로 명사 또는 명사구입니다.

• 예시) ImmutableList, Character

 

테스트 클래스 이름은 Test를 끝에 붙여줍니다

• 예시) HashTest, HastIntegrationTest

 

메서드의 이름

메서드 이름은 lowerCamelCase로 작성됩니다.

메서드 이름은 일반적으로 동사 또는 동사 구입니다.

• 예시) sendMessage, stop

 

상수의 이름

상수 이름은 CONSTANT_CASE를 이용한다

모두 대문자를 사용하고 밑줄로 단어를 구분한다.

• 예시) NUMBER, EMPTY_ARRAY

 

상수가 아닌 필드 이름, 파라미터 이름, 지역변수 이름

lowerCamelCase로 작성됩니다.

 

 

 

출처

https://shongnote.tistory.com/8

[JAVA] Google Java Convention, 구글 자바 코드 작성규칙에 대하여