public_member_api_docs

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

此規則自 Dart 2.0 起提供。

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

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

不良示範

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

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