checkstyle

Checkstyle

Checkstyle은 Java 소스 코드가 지정된 코딩 규칙을 준수하는지 확인하기 위해 소프트웨어 개발에 사용되는 정적 코드 분석 도구

설정

인텔리제이에서 플러그인 설치

환경설정 - 플러그인 - checkstyle 검색 후 설치

체크스타일 환경설정

• 환경설정 - 도구 - Checkstyle 클릭
• Configuration FIle에서 + 버튼 클릭

• Description에 Custom으로 입력

• Use a local Checkstyle file에서 /api/config/checkstyle/checkstyle.yml 선택
• 추가된 custom 파일로 설정하고 적용

코드 스타일 설정

• 환경설정 - 에디터 - 코드스타일 - Java

• 톱니바퀴 아이콘 - 구성표 가져오기 - 인텔리제이 코드 스타일
• /api/config/intellij-java-google-style 열어서 설정

코드를 체크스타일에서 설정한 스타일(구글)로 짤 수 있도록 도와주는 설정

실행 방법

• 체크스타일 플러그인을 설치하면 인텔리제이 하단에 버튼이 생성되어 있다. 이것을 클릭하면 아래와 같은 창이 뜬다.

• 이 창에서 Rules를 아까 설정한 custom으로 지정되어 있는 지 우선 확인한다.
• 확인 했다면 검사를 실행하면 된다.
  • : 현재 파일만 검사
  • : 모듈 내에서 검사
  • : 프로젝트 내에서 검사
• 검사를 진행하고 에러를 확인해서 고쳐주면 된다.

추가 꿀팁

단축키

• 자동 줄 정렬
  • Windows: Ctrl+Alt+L
  • macOS: Opt+Cmd+L
• import 최적화
  • Windows: Ctrl+Alt+O
  • macOS: Ctrl+Opt+O

자동 import 최적화

환경설정 - 에디터 - 일반 - 자동 가져오기