코딩 컨벤션
코딩 컨벤션은 가독성이 좋고 관리하기 쉬운 코드를 작성하기 위한 코딩 스타일 규칙이다. 오류를 발생시키는 오류를 줄어주어서 유지보수 비용(시간)을 줄일 수 있다.
Checkstyle
지정된 코딩 컨벤션을 준수하는지 확인하는 도구이다.
Java 언어를 사용하여 웹 프로젝트를 개발하기 위해 초기 설정으로 구글 코딩 컨벤션을 Code Style Formatter로 설정하고 Checkstyle을 적용하는 과정을 정리했다.
1. 네이버 컨벤션 다운받기
아래 깃허브 주소에서 naver-intellij-formatter.xml 파일을 다운 받는다.
Settings > Code Style - Schema 설정 > Import Schema > IntelliJ IDEA code Style XML을 선택하고, C 드라이브 아래에 다운 받은 naver-intellij-formatter.xml 파일을 선택하여 지정한다.
2. Java Tabs and Indents 설정
Settings > Code Style > Java
Google Style은 Tab size, Indent = 2로 설정되어 있으므로 4로 수정한다.
나는 네이버 컨벤션 규칙을 사용해서 다시 2, 2, 4로 변경했다.
3. Checkstyle 적용하기
naver-checkstyle-rules.xml과 naver-checkstyle-suppressions.xml를 다운로드 한다.
https://github.com/naver/hackday-conventions-java/blob/master/rule-config/naver-checkstyle-rules.xml
Settings > Plugins > CHECKStyle을 검색하고 설치 후 IntelliJ를 재부팅한다.
설치 후 Tools > Checkstyle
Scan Scope: All sources (including tests)
Treat Checkstyle errors as warnings 체크박스를 선택한다.
Description: Naver Checkstype Rules로 지정한다. (권장)
Use a Local checkstyle File > Browse > naver-checkstyle-rules.xml 선택한다.
suppressionFile 프로퍼티 값으로 naver-checkstyle-suppressions.xml을 입력한다.
4. 저장 시 코딩 컨벤션 자동 적용 설정하기
설정창에서 save를 검색한다.
Actions on Save > Reformat code, Optimize import 체크박스를 선택한다.
