[JAVA] 코딩 컨벤션

코딩 컨벤션

프로그래밍에서 일관성과 가독성을 향상시키기 위해 사용되는 규칙과 가이드라인의 모음이다.
이러한 규칙들은 코드를 작성하는 방식, 네이밍 규칙, 주석 작성, 들여쓰기 등에 대한 규칙을 포함한다.

 

 

코딩 컨벤션의 장점

1. 일관성

모든 개발자가 동일한 스타일과 가이드라인을 사용하면 코드가 일관되고 읽기 쉬워지며, 코드베이스의 유지 보수 및 이해가 훨씬 쉬워진다.

 

2. 가독성

의미 있는 변수 및 함수명, 명확한 들여쓰기, 적절한 주석 등이 코드를 이해하기 쉽게 만든다. 가독성이 높은 코드는 버그를 찾고 수정하기 쉽고, 새로운 기능을 추가하거나 수정할 때도 효율적이다.

 

3. 협업 용이성

동일한 스타일과 규칙을 공유하면 코드 리뷰, 버전 관리 및 코드 통합 작업이 더 쉬워지며, 팀 내의 개발자들 간의 의사 소통도 원활해진다.

 

4. 유지 보수성

다른 개발자나 자신이 작성한 코드를 나중에 다시 읽거나 수정해야 할 때, 일관된 컨벤션에 따라 작성된 코드는 더 쉽게 이해하고 변경할 수 있다.

 

5. 오류 예방

일관된 들여쓰기, 규칙적인 네이밍 규칙, 주석 등은 실수를 줄여주고 일반적인 프로그래밍 실수를 방지할 수 있다.

 

6. 개발자 경험 향상

일관된 스타일과 구조를 따르는 것은 개발자가 자신의 코드에 자부심을 가지고, 좀 더 효율적이고 효과적인 개발 경험을 제공한다.

 

 

자바 코딩 컨벤션의 종류

언어, 개발자 커뮤니티, 기업 또는 프로젝트에 따라 다양하다.

아래는 널리 알려진 코딩 컨벤션의 일부이다.

 

• Oracle Java 코딩 스타일 가이드 : 오라클은 자바 개발을 위한 공식적인 코딩 스타일 가이드를 제공한다. 이 가이드는 들여쓰기, 네이밍 규칙, 주석, 공백 사용, 코드 레이아웃 등 다양한 측면을 다루고 있다. https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
• Google Java 스타일 가이드 : 구글은 자바 개발에 대한 코딩 스타일 가이드를 제공하고 있다. 이 가이드는 들여쓰기, 네이밍 규칙, 주석, 공백 사용, 코드 레이아웃 등을 다루고 있으며, 몇 가지 오라클 Java 코딩 스타일과는 다른 점도 있다. https://google.github.io/styleguide/javaguide.html
• IntelliJ IDEA 코딩 스타일 : IntelliJ IDEA는 인기있는 자바 개발 도구다. IntelliJ IDEA에서 제공하는 코딩 스타일은 자동으로 코드를 포맷팅하는 기능을 제공하며, 기본적으로 IntelliJ IDEA에서 사용되는 스타일 가이드를 따른다. 이 스타일 가이드는 구글 Java 스타일 가이드를 기반으로 하지만 일부 차이가 있을 수 있다.
• Android 코딩 스타일 가이드 : 안드로이드 앱 개발을 위한 코딩 스타일 가이드도 존재한다. 이 가이드는 안드로이드 프레임워크와 관련된 자바 코드 작성에 특화되어 있으며, 들여쓰기, 네이밍 규칙, 주석, 리소스 네이밍 등을 다루고 있습니다. https://developer.android.com/kotlin/style-guide

 

 

코딩 컨벤션의 예시

들여쓰기

코드 블록을 일관된 방식으로 들여쓰는 방법을 정의한다.

주로 공백 문자나 탭 문자를 사용하며, 일반적으로 공백 문자 2개 또는 4개를 사용하는 것을 권장한다.

 

네이밍 규칙

변수, 함수, 클래스 등의 이름을 지을 때 어떤 규칙을 따를지 정의한다.

일반적으로 변수와 함수는 소문자로 시작하고, 여러 단어를 사용하는 경우에는 단어 사이에 언더스코어(_)나 카멜 케이스(camelCase)를 사용하는 것이 일반적이다.

 

주석

코드의 이해를 돕기 위해 주석을 사용하는 방법을 정의한다.

주석은 코드의 목적, 기능, 중요한 정보 등을 설명하는 데 사용되기 때문에 주석을 사용하여 코드를 이해하기 쉽게 만들고, 다른 개발자가 코드를 파악할 수 있도록 한다.

 

코드 레이아웃

코드의 가독성을 높이기 위해 중괄호의 위치, 공백의 사용 등과 같은 코드 레이아웃에 대한 규칙을 정의한다.

일반적으로 중괄호는 새로운 줄에 위치하며, 공백 문자나 빈 줄을 사용하여 코드의 그룹을 시각적으로 구분하는 것을 권장한다.

 

기타 규칙

코드 줄의 길이 제한, 주석의 사용범위, 예외 처리 방법, 상수의 표기 방법 등과 같은 다른 코딩 스타일과 관련된 규칙들도 포함할 수 있다.

 

 

코딩 컨벤션 적용해보기

IntelliJ에서도 코드 스타일을 바꿀 수 있다.

 

적용방법

1. Settings 에 들어가 Editor > Code Style > Java 를 선택한다.

2. Scheme 우측에 톱니바퀴를 누르고 Import Scheme > IntelliJ IDEA code style XML 을 선택한다.

3. 우측 하단에 OK를 누른다.

 

위 방법대로 해서 적용하고 단축키를 이용해서 코드를 정렬할 수 있다.

윈도우 : Ctrl  +  Alt  +  L
맥 : cmd + opt + L