public_member_api_docs

为所有公共成员编写文档。

应该 为所有公共成员编写文档。

所有非覆盖的公共成员都应该使用 /// doc 风格的注释进行文档化。

错误示例

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 一致，当有文档记录的 getter 具有相应的未文档记录的 setter 时，规则会有一个例外。在这种情况下，setter 会从 getter 继承文档。

要启用 public_member_api_docs 规则，请在你的 analysis_options.yaml 文件中的 linter > rules 下添加 public_member_api_docs

linter:
  rules:
    - public_member_api_docs

如果你改为使用 YAML map 语法来配置 linter 规则，请在 linter > rules 下添加 public_member_api_docs: true

linter:
  rules:
    public_member_api_docs: true

除非另有说明，否则本网站上的文档反映的是 Dart 3.7.1 版本。页面上次更新于 2025-03-07。 查看源代码 或 报告问题。