package_api_docs

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

此规则目前已弃用，自 Dart 2.0 起可用。

注意：此 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

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