자바 구글 코드 컨벤션과 IntelliJ 적용 방법

코드 컨벤션은 읽기 용이하고 관리하기 쉽게 규정한 일관된 코드 스타일이다 깐깐한 규칙을 하나하나 따르다보면 오히려 시간을 더 잡아먹을 수도 있지만, 코드 가독성이 높아져 이후 읽기에도 편하고 특히 다른 개발자와 의사소통이 훨씬 수월해진다는 장점을 가진다.

 

이번에 새로운 사이드 프로젝트를 시작하기 전 코드 컨벤션을 정하고 가기로 했다. 유명한 구글의 자바 코드 컨벤션을 따를 생각이다. 구글에서 xml 파일을 제공해주고 있어 IDE 에 설정해두면 코드 정렬 단축키로 편하게 적용할 수 있다.

 

구글 코드 컨벤션 IDE에 적용하는 방법

구글 깃허브에서 자신이 사용하는 언어와 IDE 환경에 맞는 파일을 다운받는다. 나는 Java 와 IntelliJ 조합으로 intellij-java-google-style.xml 파일을 다운받았다.

 

윈도우는 IntelliJ 의 File -> Setting -> Editor -> Code Style, 맥은 File -> Preferences -> Editor -> Code Style 로 들어가 아래 톱니바퀴의 IntelliJ IDEA code style XML 메뉴를 선택해 다운받은 파일을 Import 시켜준다.

기존 구글 컨벤션은 들여쓰기가 2 로 되어 있는데, 요즘은 4로 쓴다고 한다. 그래서 4로 바꿔주었다.

이렇게 적용해주고 코드 정리 단축키를 사용하면 구글 컨벤션대로 코드가 정렬된다! 윈도우는 전체 선택 후 Ctrl + Alt + L 이고 맥은 Option + Cmd + L 이다.

 

정리

프로젝트는 혼자 하는 것이 아니다. 내 코드를 항상 남들이 보고, 남의 코드를 항상 내가 본다. 일관된 코드 스타일을 따르지 않으면 스파게티 코드가 되고, 그렇다고 나만의 스타일을 고수하면 다른 사람들이 내 코드를 이해할 수 없게 된다.

 

다른 팀원과의 의사소통과 배려를 위해서라도 코드 컨벤션을 준수하며 코딩하는 습관을 길러야겠다.