개발자 월든
월든의 더 나은 개발하기
개발자 월든
전체 방문자
오늘
어제
  • 분류 전체보기 (17)
    • Web 개발 관련 지식 (1)
    • 웹 백엔드 프레임워크 (1)
      • FastAPI (1)
      • Spring (0)
    • 웹 프론트엔드 (0)
      • HTML (0)
      • CSS (0)
      • Vanilla JS (0)
      • React (0)
    • 데이터베이스 (2)
      • MySQL (1)
      • Cache (0)
    • 인프라 자동화 (2)
      • Docker (1)
      • kubernetes (0)
      • Jenkins (1)
    • 객체 지향 프로그래밍 (0)
    • 도메인 주도 설계 (0)
    • 마이크로서비스 아키텍쳐 (0)
    • 시스템 설계 (2)
    • 프로그래밍 언어 (6)
      • Java (6)
      • Python (0)
      • Javascript (0)
    • 알고리즘 문제풀이 (2)
      • C++ (0)
      • Java (2)
    • 컴퓨터 공학 전공 (0)
    • 개발 관련 도구 (1)

블로그 메뉴

  • 홈
  • 태그
  • 방명록

공지사항

인기 글

태그

  • JCP #JSR # TCK

최근 댓글

최근 글

티스토리

hELLO · Designed By 정상우.
개발자 월든

월든의 더 나은 개발하기

인텔리제이 Checkstyle과 Formatting으로 코드 스타일 관리하기
개발 관련 도구

인텔리제이 Checkstyle과 Formatting으로 코드 스타일 관리하기

2022. 1. 11. 22:10

인텔리제이에는 코드 스타일을 정하고 그에 맞춰 정렬되도록하는 Formatting 기능과 플러그인으로 제공되는 Checkstyle을 통해 코드 스타일을 분석할 수 있다.

구글 코드 스타일 가이드를 참고하여 이에 맞는 Formatting 설정과 Checkstyle 설정을 하도록 한다.

단 들여쓰기는 2칸에서 4칸으로 변경한다.

1. 인텔리제이 Checkstyle 시작하기

  • 인텔리제이에서 File → Settings → Plugins를 들어간다.
  • Checkstyle-IDEA를 다운로드 받는다.

체크스타일 다운로드

  • Checkstyle 설정 파일을 다운로드하고 프로젝트 내부에 .idea/config/checkstyle 디렉토리를 생성하여 저장하고 checkstyle.xml로 이름을 변경한다 (checkstyle.xml파일을 생성하여 파일 내용만 붙여넣어도 된다.)
  • checkstyle.xml 파일을 열고 Indentation을 검색하고 해당 모듈에서 2인 property값을 모두 4로 변경한다.
  • File → Settings → Tools → Checkstyle을 들어간다.
  • Configuration File에서 플러스 버튼을 클릭하고 Use a local Checkstyle file에 Browse를 클릭하여 위에서 설정한 Checkstyle.xml파일을 적용한다.

체크스타일 설정 파일 적용

  • Scan Scope를 Only Java sources (including test)로 변경한다.

스캔 범위 수정

  • 인텔리제이 하단에 CheckStyle 탭을 클릭하고 원하는 파일에서 실행을 하면 코드를 분석해준다.
  • 만약 원하는 코드 스타일이 있다면 checkstyle.xml파일을 수정하면 된다. 각 모듈과 속성 값이 무엇을 의미하는지는 여기에 Chekcs 메뉴를 보면 모두 나와있다.
  • 깃을 사용할 경우 커밋 시 체크스타일로 검사할 수 있다.

커밋 시 체크 스타일 검사하기

2. Formatting 설정하기

  • 구글 스타일 가이드를 참고한 설정 파일을 다운로드 받는다.
  • File → Settings → Editor → Code Style를 들어간다.
  • 톱니바퀴 버튼을 누르고 Import scheme → Intellij IDEA code style XML을 누른다.
  • 위에서 다운받은 intellij-java-google-style.xml을 선택한다.

포매팅 설정 변경

  • 좌측 메뉴에서 Code Style → Java를 클릭한다.
  • Tab size와 Indent를 4로 수정하고 Continuation indent는 8로 수정하고 적용한다.
  • 정렬하려는 파일을 열고 Ctrl + Alt + L을 입력하면 코드가 설정한 값에 따라 정렬된다.
    개발자 월든
    개발자 월든
    백엔드 개발자 월든의 개발 관련 포스팅을 올리는 공간입니다. 출처가 불명확한 정보, 요령, 대충 넘어가기 보다 꼼꼼하고 정확하고 기본에 가까운 정보를 드리려고 노력하고 있습니다.

    티스토리툴바