package_api_docs

Forneça comentários de documentação para todas as APIs públicas.

NOTA: Esta regra foi removida porque não funciona totalmente desde pelo menos o Dart 2.0. Remova todas as inclusões desta regra do seu arquivo de análise.

FAÇA fornecer comentários de documentação para todas as APIs públicas.

Conforme descrito no documento de layout de pacotes do pub, as APIs públicas consistem em tudo o que está na pasta lib do seu pacote, menos os arquivos de implementação em lib/src, somados aos elementos exportados explicitamente com uma diretiva export.

Por exemplo, dado lib/foo.dart:

export 'src/bar.dart' show Bar;
export 'src/baz.dart';
​
class Foo { }
​
class _Foo { }

sua API inclui:

• Foo (mas não _Foo)
• Bar (exportado) e
• todos os elementos públicos em src/baz.dart

Todos os membros públicos da API devem ser documentados com comentários no estilo de documentação ///.

RUIM:

class Bar {
  void bar();
}

BOM:

/// A Foo.
abstract class Foo {
  /// Start foo-ing.
  void start() => _start();
​
  _start();
}

Dicas para escrever bons comentários de documentação podem ser encontradas nas Diretrizes de Escrita de Documentação.

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

linter:
  rules:
    - package_api_docs

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

linter:
  rules:
    package_api_docs: true