[Intellij] springboot코드 컨벤션 설정하는 방법

코드 컨벤션이란??

특정 프로그래밍 언어나 프로젝트에서 소스 코드의 작성 스타일에 관한 규칙이나 가이드라인을 말한다.
코드 컨벤션을 따르면 소스 코드의 가독성이 향상되고, 오류를 줄이며, 협업 시 코드의 일관성을 유지할 수 있다.

캠퍼스 핵데이 Java 코딩 컨벤션

캠퍼스 핵데이라는 코딩 컨벤션을 사용하여 맞출 예정이다.

이 링크에 들어가 xml파일을 다운 받으면 된다.

이제 다운로드 받은 파일을 적용하는 단계를 거치면 된다.
setting-> Code Style에 들어가 위 사진과 같이 클릭을 해 본인이 다운 받은 xml파일을 등록하면 된다.

정상적으로 등록된 것을 볼 수 있다.

만약 뒤에 버전이 적혀져 있다면 유일성 있게 인지되도록 버전을 To에서 지워주자

CheckStyle-IDEA 설치 및 CheckStyle 구축

이 링크에 있는 xml파일을 위와 같이 똑같이 설치해준다

CheckStyle-IDEA 설치하기

Plugins에서 설치하도록 한다.

설치를 하고 나서 다시 시작하도록 한다.
그 후에 Setting-> Tools -> Checkstyle로 들어가 한번 더 Configuration File에 추가하도록 한다.

Scan scope는 All sources including tests로 설정해 모든 소스코드에 대해서 코딩컨벤션을 검사하도록 할 수 있다.
Treat Checkstyle errors as warnings를 체크해 컨센션을 어기면 경고나 에러를 발생시키도록 설정한다.

그리고 vaule값으로 naver-checkstyle-suppressions.xml를 입력한다.