公開 API に型注釈を付ける

公開 API に型注釈を付けます。

このルールは Dart 2.0 以上で利用できます。

このルールには、クイックフィックスが用意されています。

推奨： 公開 API に型注釈を付ける。

型注釈は、ライブラリの使用方法に関する重要なドキュメントです。公開メソッドと関数の引数と戻り値の型に注釈を付けることで、ユーザーは API が何を期待し、何を提供するのかを理解することができます。

Dart の型システムで表現できない値の範囲を受け入れる公開 API の場合は、型指定を省略してもかまいません。その場合、暗黙的な `dynamic` が API の正しい型になります。

ライブラリ内部のコード (プライベートなもの、またはネストされた関数のようなもの) については、役に立つと思われる場所に注釈を付けてください。ただし、必ずしも注釈を付ける必要はありません。

悪い例

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

ここでは、`id` が何なのかが不明確です。文字列でしょうか？また、`destination` は何でしょうか？文字列でしょうか、それとも `File` オブジェクトでしょうか？このメソッドは同期式でしょうか、それとも非同期式でしょうか？

良い例

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

型を指定することで、これらすべてが明確になります。

`type_annotate_public_apis` ルールを有効にするには、`analysis_options.yaml` ファイルの **linter > rules** の下に `type_annotate_public_apis` を追加します。

analysis_options.yaml
yamllinter:
  rules:
    - type_annotate_public_apis

特に明記されていない限り、このサイトのドキュメントは Dart 3.5.3 を反映しています。ページの最終更新日: 2024-07-03. ソースを表示または問題を報告する

詳細