メインコンテンツにスキップ

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