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 一致，如果已文档化的 getter 有对应的未文档化 setter，则存在一个例外情况。在这种情况下，setter 会继承 getter 的文档。

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

linter:
  rules:
    - public_member_api_docs

如果你正在使用 YAML 映射语法配置 linter 规则，请在 linter > rules 下添加 public_member_api_docs: true

linter:
  rules:
    public_member_api_docs: true