deprecation 메시지를 제공하세요

deprecation 메시지를 제공하세요

@Deprecated("message")를 통해 deprecation 메시지를 제공하라는 린트 규칙이에요. 함수나 클래스를 deprecated로 만들 때 왜, 언제 없어질지 알려주는 게 좋죠. 함께 볼게요.

출처: provide_deprecation_message

본문

Deprecated 생성자에는 deprecation 메시지(마이그레이션 안내나 제거 일정 포함)를 명시하세요.

BAD:

@deprecated
void oldFunction(arg1, arg2) {}

GOOD:

@Deprecated("""
[oldFunction] is being deprecated in favor of [newFunction] (with slightly
different parameters; see [newFunction] for more information). [oldFunction]
will be removed on or after the 4.0.0 release.
""")
void oldFunction(arg1, arg2) {}

켜는 방법

provide_deprecation_message 규칙을 사용하려면 analysis_options.yaml 파일의 linter > rules 아래에 provide_deprecation_message를 추가해요:

linter:
  rules:
    - provide_deprecation_message

만약 YAML 맵 문법으로 린트 규칙을 설정한다면 linter > rules 아래에 provide_deprecation_message: true를 추가하면 돼요:

linter:
  rules:
    provide_deprecation_message: true

더 알아보기