package_api_docs

为所有公共 API 提供文档注释。

注意：此 Lint 已被移除，因为它至少自 Dart 2.0 以来就未完全正常工作。从你的分析选项中移除对此 Lint 的所有引用。

务必为所有公共 API 提供文档注释。

如 pub 包布局文档所述，公共 API 包括包的 lib 文件夹中的所有内容，减去 lib/src 中的实现文件，并加上通过 export 指令显式导出的元素。

例如，对于 lib/foo.dart

export 'src/bar.dart' show Bar;
export 'src/baz.dart';

class Foo { }

class _Foo { }

其 API 包括

• Foo (但不包括 _Foo)
• Bar (已导出) 以及
• src/baz.dart 中的所有 公共 元素

所有公共 API 成员都应使用 /// 风格的文档注释进行记录。

不好的示例

class Bar {
  void bar();
}

好的示例

/// A Foo.
abstract class Foo {
  /// Start foo-ing.
  void start() => _start();

  _start();
}

有关如何编写好的文档注释的建议，请参阅文档编写指南。

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

linter:
  rules:
    - package_api_docs

如果你使用的是 YAML 映射语法来配置 Linter 规则，请在 linter > rules 下添加 package_api_docs: true

linter:
  rules:
    package_api_docs: true