type_annotate_public_apis

パブリック API に型注釈を付けます。

From Effective Dart

推奨: パブリック API に型注釈を付けましょう。

型注釈は、ライブラリをどのように使用すべきかを示す重要なドキュメントです。パブリックなメソッドや関数のパラメータと戻り値の型に注釈を付けることで、ユーザーは API が何を期待し、何を提供するのかを理解するのに役立ちます。

Dart の型システムで表現できない値の範囲を受け入れるパブリック API の場合、型付けしないことが許容されることに注意してください。その場合、暗黙的な dynamic が API の正しい型となります。

ライブラリ内部のコード（プライベートなものや、ネストされた関数など）については、役立つと思われる場所に注釈を付けますが、必須だと感じる必要はありません。

悪い例

install(id, destination) {
  // ...
}

ここでは、id が何であるかが不明確です。文字列ですか？ そして destination は何ですか？ 文字列ですか、それとも File オブジェクトですか？ このメソッドは同期ですか、非同期ですか？

良い例

Future<bool> install(PackageId id, String destination) {
  // ...
}

型があれば、これらすべてが明確になります。

type_annotate_public_apis ルールは、以下のルールと互換性がありません。

• omit_obvious_property_types

type_annotate_public_apis ルールを有効にするには、analysis_options.yaml ファイルの linter > rules の下に type_annotate_public_apis を追加してください。

linter:
  rules:
    - type_annotate_public_apis

代わりに YAML マップ構文を使用してリンター ルールを構成している場合は、linter > rules の下に type_annotate_public_apis: true を追加してください。

linter:
  rules:
    type_annotate_public_apis: true