package_api_docs

すべての公開APIにドキュメントコメントを記述します。

このルールは現在非推奨であり、Dart 2.0以降で使用できます。

注：このlintは、少なくともDart 2.0以降、完全に機能していないため非推奨になっています。analysis optionsからこのlintのすべての記述を削除してください。

必ずすべての公開APIにドキュメントコメントを記述してください。

pubパッケージレイアウトドキュメントで説明されているように、公開APIはパッケージの`lib`フォルダ内のすべてのものであり、`lib/src`内の実装ファイルは除外されます。`export`ディレクティブで明示的にエクスポートされた要素を追加します。

例として、`lib/foo.dart`があるとします。

export 'src/bar.dart' show Bar;
export 'src/baz.dart';

class Foo { }

class _Foo { }

そのAPIには以下が含まれます。

• `Foo`（ただし`_Foo`は除く）
• `Bar`（エクスポート済み）と
• `src/baz.dart`内のすべての公開要素

すべての公開APIメンバーには、`///`ドキュメントスタイルのコメントを使用して記述する必要があります。

悪い例

class Bar {
  void bar();
}

良い例

/// A Foo.
abstract class Foo {
  /// Start foo-ing.
  void start() => _start();

  _start();
}

良いドキュメントコメントの記述方法については、ドキュメント作成ガイドラインを参照してください。

`package_api_docs`ルールを有効にするには、`analysis_options.yaml`ファイルのリンター > ルールの下に`package_api_docs`を追加します。

linter:
  rules:
    - package_api_docs

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