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

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

linter:
  rules:
    - public_member_api_docs

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