package_api_docs

為所有公開 API 提供文件註解。

此規則目前已過時，並自 Dart 2.0 起可用。

注意：此 linter 已過時，因為它至少自 Dart 2.0 以來就未完全運作。請從您的分析選項中移除所有包含此 linter 的項目。

務必為所有公開 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。 檢視原始碼 或回報問題。