IntelliJ / 코딩 컨벤션 적용하기

왜 코딩 컨벤션(Coding Convention)을 적용해야 할까?

개인 프로젝트가 아닌 이상, 우리는 항상 협업을 하게 됩니다.
이때, 한 사람 한 사람마다 코드를 짜는 방법은 다를 수 있습니다.

예를 들어, if문을 작성한다고 합시다.

개발자 A

if (true) {
  return;
}

개발자 B

if(true) return;

예시는 굉장히 간략한 코드를 예시로 들었지만, 운영할 서비스는 굉장히 복잡한 코드로 몇만, 몇십 만 줄 이상이 모여 구성될 것입니다.

이럴 경우 코드의 의도를 파악하기 어려워지고, 오류를 발생시킬 수 있는 잠재적 위험으로부터 안전하지 않습니다.
즉, 유지보수에 굉장히 치명적이라는 것입니다.

이제, 개발하고 있는 IDE에 코딩 컨벤션을 적용하여 프로젝트의 가독성을 더욱 뛰어나게 만들어봅시다.

1. 코딩 컨벤션 다운로드

일반적으로 회사에서는 정해진 자체 컨벤션을 사용할 것이지만,
개인 프로젝트이기 때문에 구글 자바 코딩 컨벤션을 사용하겠습니다.

스타일 가이드
깃허브

1-1. style 파일 확인

깃허브에 들어가 사용 중인 IDE의 style xml 파일이 있는지 확인합니다.

저는 인텔리제이를 사용하기 때문에 위의 파일을 사용하겠습니다.

1-2. style 파일 다운로드

파일을 클릭해 들어간 다음, [Raw] 버튼을 우클릭하여 [다른 이름으로 링크 저장]으로 다운로드합니다.

1-3. 인텔리제이 환경 설정

인텔리제이 > 환경 설정 > [Editor > Code Style > Java]로 접근 후, 톱니바퀴 아이콘을 클릭하여 [Import Scheme > IntelliJ IDEA code style XML]을 클릭하여 다운로드한 xml을 선택해 줍니다.

설정 전으로, Default Convention이 적용되어있다.

설정 전과 달리 Tab size, Indent가 달라진 것을 볼 수 있다.

2. 코딩 컨벤션 적용 대상 설정

위에서 가정했듯 수많은 개발자와 수많은 코드가 존재한다면 분명 Git, SVN 등으로 버전 관리가 되고 있을 것입니다.
위에서 설정한 대로라면 수정한 파일의 전체 포맷이 Reformat이 되기 때문에 버전 관리에는 불필요합니다.

이에 내가 수정한 코드의 줄만 코딩컨벤션이 적용될 수 있도록 아래와 같이 [Tools > Actions on Save > Reformat code]를 체크하고, Whole file을 Changed lines로 변경해 줍니다.
(그 외 파일 별로 동작을 제한하고 싶다면 옆의 All file types에서 적절히 예외처리가 가능합니다.)

3. 마치며...

이번 게시글에서는 프로젝트에 코딩 컨벤션을 적용해 보았습니다.
앞으로는 조금 더 깔끔한 코드로 게시글을 작성할 수 있겠습니다.

감사합니다.