public_member_api_docs

為所有公開成員加上文件。

務必為所有公開成員加上文件。

所有非覆寫的公開成員都應使用 /// doc-style 註解來撰寫文件。

不良範例

class Bad {
  void meh() { }
}

良好範例

/// A good thing.
abstract class Good {
  /// Start doing your thing.
  void start() => _start();

  _start();
}

如果公開成員覆寫了成員，則由宣告成員來提供文件。例如，在以下程式碼中，Sub 不需要為 init 撰寫文件 (當然，如果需要的話也可以撰寫)。

良好範例

/// Base of all things.
abstract class Base {
  /// Initialize the base.
  void init();
}

/// A sub base.
class Sub extends Base {
  @override
  void init() { ... }
}

請注意，與 dart doc 一致，規則的例外情況是，當有文件化的 getter 具有對應的未文件化 setter 時。在這種情況下，setter 會繼承 getter 的文件。

若要啟用 public_member_api_docs 規則，請在您的 analysis_options.yaml 檔案中的 linter > rules 下方新增 public_member_api_docs

linter:
  rules:
    - public_member_api_docs

如果您改為使用 YAML map 語法來設定 linter 規則，請在 linter > rules 下方新增 public_member_api_docs: true

linter:
  rules:
    public_member_api_docs: true

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