인텔리제이 코딩 컨벤션 설정

코딩 컨벤션

해당 언어로 작성된 프로그램의 각 측면에 대한 프로그래밍 스타일, 관행 및 방법을 권장하는 특정 프로그래밍 언어에 대한 일련의 지침  (출처: 위키백과)

 

 

코딩 컨벤션을 사용해야 하는 이유

• 소프트웨어 개발 비용의 80%는 유지보수에 쓰인다.
• 소프트웨어 유지보수는 직접 개발한 개발자가 하는경우가 적다.
• 코딩 규칙을 지키면 다른 사람도 코드를 더 빠르게 이해하고 가독성이 높아진다.

즉 같은 컨벤션을 쓰는 사람끼리 서로 코드의 이해도가 향상된다.

따라서 협업하고 유지보수할 때 훨씬 더 가독성이 좋고 간편하다.

그렇기 때문에 이번 프로젝트에서 인텔리제이 초기 세팅하고 시작하면서 아예 설정하기로 결정했다.

 

 

 

 

JAVA의 코딩 컨벤션의 종류

• NAVER : 캠퍼스 핵데이 Java 코딩 컨벤션
• Google : Google Java Style Guide
• Oracle : Code Conventions for the Java

더 많은 컨벤션이 있을 수 있겠지만 가장 많이 사용되는 컨벤션은 3가지 인 것 같다.

나는 네이버 컨벤션과 구글 컨벤션은 봤는데 oracle은 잘 몰랐다. (지금도 잘 모름)

우리는 구글 컨벤션을 따르기로 했고 여러 블로그들을 참고해서 세팅했다.

 

 

 

 

 

Google 컨벤션 세팅

1. 코딩 컨벤션 다운로드

https://github.com/google/styleguide

GitHub - google/styleguide: Style guides for Google-originated open-source projects

 

위 깃허브에서 intellij-java-google-style.xml 파일을 다운로드 받는다.

 

2. 인텔리제이 설정

 

settings > Code Style 에서 다운받은 파일을 import 해준다.

 

 

Java 언어에서 추가로 설정해준다.

원래는 Tab size, Indent가 2로 설정되어있는데, 이를 4로 수정해준다.

 

 

또 Assignment operators가 체크되지 않은 경우 같이 체크해준다.

나는 체크가 원래부터 되어있었는데, 띄어쓰기가 있는 경우 더 가독성이 좋으므로 안되어 있으면 체크해두는 걸 추천한다.

 

 

3. 사용하기

적용하고 싶은 코드에서 ctrl+alt+L (option + command + L) 단축키를 누르면 자동으로 컨벤션이 적용이 된다.

 

 

 

 

 

 

추가 Code style 플러그인 설치

code style 플러그인을 설치해주고 추가로 설정을 해주면 추가적으로 코드 툴을 설정할 수 있다.

 

 

preferences > tools > Checkstyle 에서 Google Checks를 체크해주고 Active 설정을 해둔다.

 

이렇게 되면 적용되지 않은 컨벤션이면

 

이렇게 경고창이 나온다.

적용된 이후에 새 프로젝트를 설정 안해서 적용되는 건 나중에 확인할 수 있을 것 같다.

 

 

 

 

 

 

 

 

 

---

이번에 새롭게 설정하는 것들이 많아서 참 새롭고 재밌다.

프로젝트 기획부터 세팅까지...이번에도 많이 배울 것 같다.

 

참고

https://velog.io/@ozragwort/JAVA-%EC%BD%94%EB%94%A9-%EC%BB%A8%EB%B2%A4%EC%85%98%EC%97%90-%EB%8C%80%ED%95%B4%EC%84%9C

https://055055.tistory.com/97