Coding Conventions

박종호·2024년 1월 25일

Git/Github

목록 보기

3/3

🤔 가독성 좋고 관리하기 쉬운 코드를 작성하기 위한, 코딩 컨벤션에 대해서 알아보고 적용해보자!

1. 코딩 컨벤션이란

코딩 컨벤션(Coding Convention)이란 프로그래머들 사이에서 정해놓은 코드 작성 규칙 을 말합니다.
컨벤션을 지켜서 코드를 작성하면 코드의 가독성을 증가시키고, 여러명이 협업할 때 일관된 코드 스타일을 유지할 수 있어서 관리가 용이하기 때문에 개발자 협업에서 굉장히 중요한 부분입니다.

2. 코딩 컨벤션 지키는 방법

IDE를 사용하여 코드를 작성한다면 다음과 같은 단축 키를 사용하여 코딩 컨벤션을 자동화(포맷팅)할 수 있습니다. 보통 공백수정, import 포맷 수정, 개행 등의 수정을 해줍니다.

Intellij : ctrl + alt + L
Eclipse : ctrl + shift + f

Intellij 에서 Java 코딩 컨벤션 적용하기

코딩컨벤션을 적용하기 위해 현업에서는 정적 코드 분석 도구(ex. SonarQube)를 두기도 하고, 각 로컬 IDE환경에서 Checkstyle 같은 도구를 사용합니다.

그럼 Java에서 많이 사용하는 네이버 코딩 컨벤션을 Intellij에서 적용해봅시다.

formatter를 다운로드해줍니다
naver-intelij-formatter.xml 파일을 아래 사이트로 이동하여 받아두겠습니다!
https://github.com/naver/hackday-conventions-java/tree/master/rule-config
Preferences 설정으로 들어가서 code style을 찾습니다.

Scheme: Default IDE로 되어있는 부분에서 오른쪽에 있는 톱니바퀴 아이콘을 누르고 위에서 다운받았던 naver-intellij-formatter을 원하는 이름으로 등록하면 됩니다.

OK 버튼을 누르면 아래와같이 naver-coding-convention으로 등록이 된 것을 확인하실 수 있습니다.
번외로, IDE에서 코드를 저장할 때마다 컨벤션을 적용하도록 할 수 있습니다.

코드 저장시 컨벤션 적용 자동화

Preferences > ‘actions on save’ 검색
Reformat code 체크 : 코드 포맷팅을 저장할 때마다 자동으로 해줍니다.
Optimize imports 체크 : class에서 사용하지 않는 import를 자동으로 지워줍니다.

checkStyle 적용
Preferences > Plugins 검색 > checkstyle 검색하여 CheckStyle-IDEA Install 버튼을 누릅니다.
설치 후에는 재시작을 해주어야 적용이 됩니다.
재시작을 하고나면 아래 이미지처럼 Tools 하위에 Checkstyle 탭이 생성되어있을겁니다.

만약 Treat Checkstyle errors as warnings 를 체크해주면 앞으로 코딩할 때 포맷에 맞지 않은 스타일이 있을 경우에는 IDE에서 warnings로 표시해줍니다. 필요하다면 체크를 해주세요.
그리고 + 버튼을 눌러서 위에서 다운받았던 rules.xml 파일을 추가해주고 next로 넘어갑니다.

여기에 naver-checkstyle-suppressions.xml를 입력해줄게요.
Next를 누르면 다음과 같이 ready to add 상태가 됩니다. Finish를 누르고 완료해줄게요.
5. 확인해보기
CheckStyle 플러그인 설치를 했다면 상단 바에 Tool Windows > CheckStyle 탭이 생겼을겁니다.
눌러주시면 IDE 하단에 CheckStyle > Scan에서 코딩컨벤션 오류를 확인할 수 있습니다.