public_member_api_docs

文件化所有公共成員。

務必文件化所有公共成員。

所有未覆蓋的公共成員都應使用 /// 文件風格註釋進行文件化。

錯誤示例

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 對映語法配置 linter 規則，請在 linter > rules 下新增 public_member_api_docs: true

linter:
  rules:
    public_member_api_docs: true