public_member_api_docs

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

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

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

悪い例

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

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

linter:
  rules:
    public_member_api_docs: true