跳到主要内容

document_ignores

稳定版

文档忽略注释。

详情

#

务必 为所有忽略的诊断报告添加文档注释。

错误示例

dart
// ignore: unused_element
int _x = 1;

正确示例

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

启用

#

要启用 document_ignores 规则,请在您的 analysis_options.yaml 文件中的 linter > rules 下添加 document_ignores

analysis_options.yaml
yaml
linter:
  rules:
    - document_ignores

如果您改为使用 YAML 映射语法来配置 linter 规则,请在 linter > rules 下添加 document_ignores: true

analysis_options.yaml
yaml
linter:
  rules:
    document_ignores: true