package_api_docs

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

注意: このリンターは、Dart 2.0 以降、完全に機能しなくなっているため削除されました。分析オプションからこのリンターのすべてのインクルードを削除してください。

DO すべての公開 API にドキュメントコメントを提供します。

pub パッケージレイアウトのドキュメント (pub package layout doc) で説明されているように、公開 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 ファイルの linter > rules の下に package_api_docs を追加します。

linter:
  rules:
    - package_api_docs

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

linter:
  rules:
    package_api_docs: true