public_member_api_docs

すべての公開メンバーを文書化する。

このルールはDart 2.0から利用可能です。

必ずすべての公開メンバーを文書化してください。

オーバーライドしないすべての公開メンバーは、/// ドックスタイルコメントで文書化する必要があります。

悪い例

class Bad {
  void meh() { }
}

良い例

/// A good thing.
abstract class Good {
  /// Start doing your thing.
  void start() => _start();

  _start();
}

公開メンバーが他のメンバーをオーバーライドする場合、宣言側のメンバーがドキュメントを提供する必要があります。例えば、以下の例では、Subはinitを文書化する必要はありません（必要であればもちろん文書化しても構いません）。

良い例

/// Base of all things.
abstract class Base {
  /// Initialize the base.
  void init();
}

/// A sub base.
class Sub extends Base {
  @override
  void init() { ... }
}

dart docと同様に、文書化されたゲッターに対応するセッターが文書化されていない場合、例外が適用されます。この場合、セッターはゲッターからドキュメントを継承します。

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

linter:
  rules:
    - public_member_api_docs

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