document_ignores 린트 규칙

무시(ignore) 주석에 설명을 달도록 안내하는 린트 규칙이에요.

출처: document_ignores

본문

무시하는 모든 진단 보고(diagnostic report)에는 설명을 남기는 게 좋아요.

// ignore: unused_element
int _x = 1;

// ignore: unused_element 주석만 있고 왜 무시하는지 설명이 없네요.

// This private field will be used later.
// ignore: unused_element
int _x = 1;

무시 주석 위에 // This private field will be used later.처럼 왜 무시하는지 설명을 달았어요. 이렇게 하면 나중에 코드를 보는 사람이 의도를 이해할 수 있어요.

이 규칙을 활성화하려면 analysis_options.yaml 파일의 linter > rules 아래에 document_ignores을 추가하면 돼요.

linter:
  rules:
    - document_ignores

linter > rules를 YAML map 문법으로 작성한다면 document_ignores: true처럼 불리언 값을 지정해도 되고요.

linter:
  rules:
    document_ignores: true

ignore 주석을 정리하는 더 자세한 방법은 Dart의 진단과 린트 관련 문서를 참고해 보세요. 린트 규칙 전체 목록은 공식 Linter rules 문서에서 확인할 수 있어요.