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

除非另有說明，否則本網站上的文件反映 Dart 3.7.1 版本。頁面最後更新於 2025-03-07。 檢視原始碼 或回報問題。