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