코드 스타일

작업을 하다보면 같이 협업할 때가 많다. 만약 누구는 변수 선언 시 카멜케이스, 다른 사람은 스네이크 케이스 등 섞어서 사용하게 되면, 프로젝트 내에 소스 코드는 난잡해지기 마련이다. 프로젝트의 코드 컨벤션은 이런 역할을 방지하고자 하는 하나의 약속이다. 작업에 집중하다 보면 자연스럽게 코드 스타일을 신경쓰지 않게 된다. 좋은 코드도 좋지만 좋은 코드 스타일은 가독성을 향상 시켜준다. 코드 스타일 가이드를 제공하는 벤더사가 다양하지만, 구글 코드 스타일 가이드를 참고해서 내가 사용하는 개발 툴에 적용하자.

 

인텔리제이에 코드 스타일 적용방법

먼저 구글에서 제공하는 코드 스타일 파일을 다운받아야 한다. 아래 링크에서 해당 파일을 다운로드 한다.

https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml

다운로드를 받았으면 Intellij IDEA -> Settings -> Editor -> Code Style를 차례로 누른다.(ctrl + alt + s)

상단의 톱니 바퀴를 클릭하고 Import Scheme -> Intellij IDEA code style scheme를 선택한다.

그러면 파일을 선택하는 창이 나오는데 이때 다운 받은 xml파일을 선택해서 적용 시킨다. 그리고 Google Style창이 나오는데 ok를 눌러 적용한다. 만약 세부적으로 적용을 바꿔야 하는 것이 있으면 아래 항목에서 찾아서 변경한다.

 

 

여기까지 하면 구글 코드 스타일 가이드를 적용한거다. 하지만 이대로 한다면 ctlr + alt + L or option + command + L로 매번 코드 스타일을 적용시켜야 한다. 저장을 할 경우 자동으로 코드를 변환하게 설정한다.

Tools - Actions on save -> 저장 시 동작하는 옵션 지정하는 창이다.

Reformat Code -> save 할 경우 자동으로 코드 변경, 프로젝트 버전 관리 시 변경된 코드만 적용한다

Optimize Imports -> 사용하지 않는 import문을 제거한다

Rearrange, Code Cleanup 등은 메소드의 위치를 변경하거나 사이드 이펙트를 변경시킬 가능성이 있어서 적용하지 않는다.

 

 

아래 링크는 코드 규칙이 적용되는 기준이 설명되어 있는 구글 사이트이다.

https://google.github.io/styleguide/javaguide.html

 

참고

https://yozm.wishket.com/magazine/detail/2499/

https://yeon-kr.tistory.com/197

https://zerobit.tistory.com/21