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.6.0。页面上次更新时间为 2024-07-03。 查看源代码 或 报告问题。