dangling_library_doc_comments

Anexe comentários de documentação de biblioteca às diretivas library.

Anexe comentários de documentação de biblioteca (com ///) às diretivas library, em vez de deixá-los soltos perto do início da biblioteca.

RUIM:

/// This is a great library.
import 'package:math';

/// This is a great library.
​
class C {}

BOM:

/// This is a great library.
library;
​
import 'package:math';
​
class C {}

NOTA: Uma biblioteca sem nome, como library; acima, só é suportada no Dart 2.19 e versões posteriores. Código que pode rodar em versões anteriores do Dart precisará informar um nome na diretiva library.

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

linter:
  rules:
    - dangling_library_doc_comments

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

linter:
  rules:
    dangling_library_doc_comments: true