Pular para o conteúdo principal

dangling_library_doc_comments

Detalhes sobre o diagnóstico 'dangling_library_doc_comments' produzido pelo analisador do Dart.

Dangling library doc comment.

Descrição

#

O analisador emite este diagnóstico quando um comentário de documentação que parece ser documentação de biblioteca não é seguido por uma diretiva library. Mais especificamente, ele é emitido quando um comentário de documentação aparece antes da primeira diretiva da biblioteca, supondo que ele não seja uma diretiva library, ou aparece antes da primeira declaração de nível superior e está separado da declaração por uma ou mais linhas em branco.

Exemplo

#

O código a seguir produz este diagnóstico porque há um comentário de documentação antes da primeira diretiva import:

dart
/// This is a great library.
import 'dart:core';

O código a seguir produz este diagnóstico porque há um comentário de documentação antes da primeira declaração de classe, mas há uma linha em branco entre o comentário e a declaração.

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

Correções comuns

#

Se o comentário for documentação da biblioteca, adicione uma diretiva library sem nome:

dart
/// This is a great library.
library;
​
import 'dart:core';

Se o comentário for documentação da declaração seguinte, remova a linha em branco:

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

Encontrou essa página sem tradução ou que precisa de correção? Abra uma issue e nos ajude a manter esse site em PT-BR para ajudar pessoas como você.