public_member_api_docs

Documente todos os membros públicos.

FAÇA documentar todos os membros públicos.

Todos os membros públicos que não sobrescrevem outros membros devem ser documentados com comentários no estilo de documentação ///.

RUIM:

class Bad {
  void meh() { }
}

BOM:

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

Caso um membro público sobrescreva um membro, cabe ao membro que o declara fornecer a documentação. Por exemplo, no código a seguir, Sub não precisa documentar init (embora possa fazê-lo, se houver necessidade).

BOM:

/// Base of all things.
abstract class Base {
  /// Initialize the base.
  void init();
}
​
/// A sub base.
class Sub extends Base {
  @override
  void init() { ... }
}

Observe que, de forma consistente com o dart doc, há uma exceção à regra quando getters documentados têm setters correspondentes sem documentação. Nesse caso, os setters herdam a documentação dos getters.

Para ativar a regra public_member_api_docs, adicione public_member_api_docs em linter > rules no seu arquivo analysis_options.yaml:

linter:
  rules:
    - public_member_api_docs

Se você usa a sintaxe de mapa YAML para configurar as regras de lint, adicione public_member_api_docs: true em linter > rules:

linter:
  rules:
    public_member_api_docs: true