document_ignores

Learn about the document_ignores linter rule.

Stable

Released in Dart 3.5

Document ignore comments.

DO document all ignored diagnostic reports.

BAD:

dart

// ignore: unused_element
int _x = 1;

GOOD:

dart

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

To enable the document_ignores rule, add document_ignores under linter > rules in your analysis_options.yaml file:

analysis_options.yaml

yaml

linter:
  rules:
    - document_ignores

If you're instead using the YAML map syntax to configure linter rules, add document_ignores: true under linter > rules:

analysis_options.yaml

yaml

linter:
  rules:
    document_ignores: true

Was this page's content helpful?

除非另有说明，文档之所提及适用于 Dart 3.12.2 版本报告页面问题.

Details