跳到主要内容

avoid_renaming_method_parameters

稳定
推荐
提供修复

不要重命名被重写的方法的参数。

详情

#

不要重命名被重写的方法的参数。

dart doc 生成文档时,重写了另一个方法但没有自己的文档注释的方法将继承被重写的方法的注释。如果继承的方法包含参数的名称(在方括号中),则 dart doc 无法正确链接它。

不良

dart
abstract class A {
  m(a);
}

abstract class B extends A {
  m(b);
}

良好

dart
abstract class A {
  m(a);
}

abstract class B extends A {
  m(a);
}

启用

#

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

analysis_options.yaml
yaml
linter:
  rules:
    - avoid_renaming_method_parameters

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

analysis_options.yaml
yaml
linter:
  rules:
    avoid_renaming_method_parameters: true