재작성 작업을 사용하여 주석에 매개변수 추가

이 블로그 게시물에서는 다음과 같은 내용을 다룰 것입니다.

• 검색 및 매칭 주석 시연
• 콧수염 템플릿을 사용한 아멘 주석

Sensei는 문제가 있는 코드 패턴을 일치시킨 다음 합의된 구현에 맞게 수정할 수 있는 기능을 제공합니다.이 예제에서는 매개 변수가 없는 @Disabled 를 문제가 되는 코드 패턴으로 사용하고 있습니다.

비활성화된 테스트 주석

특정 이유 없이 테스트를 비활성화하면 테스트를 비활성화한 이유를 잊어버리기 때문에 장기적으로 문제가 될 수 있습니다.

@Disabled
void 이 테스트 메서드에는 비활성화된 이유가 없습니다. () {
Assertions.fail (“이 테스트는 비활성화되었으므로 실행해서는 안 됩니다.”)
}

시간이 지나면서 코드 기반이 바뀌고 비활성화된 테스트가 코드의 목적에 맞게 업데이트되지 않아 결국 중복되고 관련성이 없어져 다시 활성화되지 않을 수 있다는 위험이 있습니다.

코드 리뷰 과정에서 주석 매개변수로 설명을 추가하는 것이 좋다는 점을 자주 지적할 것입니다.

@Disabled (“이유 추가를 시연하기 위해 비활성화됨”)
void 이 테스트 메서드가 비활성화되었습니다. Reason () {
Assertions.fail (“이 테스트는 비활성화되었으므로 실행해서는 안 됩니다.”)
}

선생님 레시피

설명 없이 @Disabled 가 추가될 때 이를 감지하는 레시피와 비활성화한 이유를 설명하는 실제 이유를 추가하도록 상기시켜주는 Quick Fix를 작성할 수 있습니다.

내가 무엇을 할 것인지 생각할 때 나는 다음과 같이 해야 한다.

• 매개변수 없이 Disabled 주석을 일치시키십시오.
• Disabled 주석을 “TODO: 여기에 설명 추가”라는 마커 텍스트가 있는 매개 변수를 갖도록 변경합니다.

경고 레시피 만들기

Alt+Enter를 사용하여 새 레시피를 만듭니다.

그런 다음 일반 정보에 기본 설명 텍스트를 추가합니다.

규칙을 경고로 만들면 일치하는 코드가 강조 표시되지만 눈에 띄는 오류로 표시되지는 않습니다.

주석 찾기

레시피 편집기에서 주석과 일치하도록 검색을 변경합니다.

그러면 미리보기에서 모든 주석이 강조 표시됩니다.

이제 주석 유형을 기준으로 필터링하고 싶습니다.

Disabled를 사용할 수도 있지만 JUnit 5의 주석과만 일치하도록 패키지로 클래스를 완전히 검증합니다.소스 코드가 미리보기에 표시되기 때문에 오타를 방지하기 위해 실제 코드에서 소스 코드를 쉽게 복사하여 붙여넣을 수 있습니다.

그런 다음 매개변수가 없는 주석만 매칭하고 싶은데 GUI를 사용하여 매칭할 수 있습니다.

즉, 검색:

검색:
주석:
유형: “org.junit.Jupiter.API.Disabled”
미포함:
매개변수:
- {}

재작성 빠른 수정 작업 생성

QuickFix의 경우 재작성 작업을 사용하겠습니다.

나는 사용한다 변수 보기 Mustache 변수를 보여주고 내용을 미리 볼 수 있는 기능입니다.

그런 다음 장소 표시 댓글을 만드는 데 필요한 추가 코드를 추가합니다.

즉, 퀵픽스:

사용 가능한 수정 사항:
- 이름: “할 일 설명 매개 변수 추가”
조치:
- 다시 작성:
받는 사람: “{{{.}}} (\" TODO: 여기에 설명을 추가하세요\”)”
대상: “본인”

센세이 인 액션

레시피 제작 과정을 보여주는 짧은 비디오를 만들었습니다.

요약

재작성 Quick Fix를 빌드할 때 다시 작성하려는 코드 요소를 검색할 수 있으면 작업이 더 쉬워집니다. 그러면 해당 요소가 작업을 수행할 수 있는 자체 엔티티이기 때문입니다.

이 예제에서는 재작성 작업을 사용하여 주석을 수정했습니다.재작성은 모든 코드 요소에 적용할 수 있는 범용 작업이며 탐색하기에 좋은 기본 작업입니다.