[intellij] 인텔리제이에 xml 파일을 통해 코딩컨벤션 적용하기

코딩컨벤션이란 특정 언어에 대하여 읽고, 관리하기 쉬운 코드를 작성하기 위해 정한 코딩 규약을 말한다. 이러한 규약의 예로 아래 네이버 코딩 컨벤션이 있다. https://naver.github.io/hackday-conventions-java/

 

이러한 코딩 컨벤션은 분량이 많고, 복잡하여 개발자가 100% 완벽하게 숙지하기 어려울 수 있다. 이럴 때는 IDE의 도움을 받을 수 있다. 여기서는 인텔리제이에 규약이 적혀있는 xml 문서를 통해 코딩컨벤션을 적용하는 방법을 알아본다.

 

규약 xml 문서는 naver-intellij-formatter.xml을 사용한다. 다음 페이지에서 다운로드 받을 수 있다. https://naver.github.io/hackday-conventions-java/

맥 기준으로 인텔리제이 메뉴의 Preference -> Editor -> Code Style -> Java를 클릭한다.

등장하는 화면에서 Show Scheme Action(톱니바퀴모양) -> import Schema -> intelliJ IDE code style XML을 클릭하여 xml 파일을 추가해준다.

 

이후 부터는 작성한 코드 위에 option + command + L을 입력하면, 자동으로 코딩 컨벤션이 적용된다. 예시를 살펴보자.

아래 코드는 아파트 매매 데이터를 가져오는 API를 사용하는 코드다. 보이는 것 처럼 엉망 진창으로 들여쓰기가 적용되어있다.

 

여기에 option + command + L을 입력하면, 아래와 같이 코딩 컨벤션이 적용된 깔끔한 코드를 확인할 수 있다.