CheckStyle 적용

Geek Cat·2024년 10월 30일

우테코의 3주차 미션에서 '프로그래밍 요구 사항'으로 함수의 길이 15라인을 넘어가지 않도록 구현하는 것을 추가했습니다.

그래서 저는 CheckStyle 플러그인을 사용해서 혹시라도 15줄을 넘어가는 함수를 구현하지 않도록 하였습니다.

플러그인 설치

Idea에서 CheckStyle-IDEA를 설치합니다.

설정 파일 생성

.idea 아래에 checkstyle.xml 파일을 생성한다. (파일 위치과 이름은 상관 없다). 그리고 다음을 입력한다.

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.sourceforge.io/dtds/configuration_1_3.dtd">

<module name="Checker">
    <module name="TreeWalker">
        <module name="MethodLength">
            <property name="max" value="17"/>
        </module>
    </module>
</module>

설정한 값을 17으로 한 이유는 라인을 계산할 때 {}를 포함하여 계산되기 때문에 15가 아닌 17로 설정 하였습니다.

설정 파일 적용

Setting -> Tools -> CheckStyle 에 가서 설정파일을 추가한다.

결과

15라인 일 때,

16라인 일 때,

통합 검사

다음과 같이 프로젝트에 있는 모든 코드에 대해 검사를 할 수 있습니다.

profile
안녕하세요. 개발자 Geek Cat 입니다.

2개의 댓글

comment-user-thumbnail
2024년 11월 7일

혹시 windows는 다른 설정이 필요할까요? 설정 파일 추가가 안되네요;

1개의 답글