Pular para o conteúdo principal

unintended_html_in_doc_comment

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

Angle brackets will be interpreted as HTML.

Descrição

#

O analisador emite este diagnóstico quando um comentário de documentação contém texto entre colchetes angulares (<...>) que não é uma das exceções permitidas.

Esse texto é interpretado pelo Markdown como uma tag HTML, o que raramente é a intenção.

Consulte a descrição da regra de lint para ver a lista de exceções permitidas.

Exemplo

#

O código a seguir produz este diagnóstico porque o comentário de documentação contém o texto <int>, que não é uma das exceções permitidas:

dart
/// Converts a List<int> to a comma-separated String.
String f(List<int> l) => '';

Correções comuns

#

Se o texto deveria fazer parte de um trecho de código, coloque crases ao redor do código:

dart
/// Converts a `List<int>` to a comma-separated String.
String f(List<int> l) => '';

Se o texto deveria fazer parte de um link, coloque colchetes ao redor do código:

dart
/// Converts a [List<int>] to a comma-separated String.
String f(List<int> l) => '';

Se o texto deveria ser exibido exatamente como está, incluindo os colchetes angulares, escape os colchetes angulares com barra invertida:

dart
/// Converts a List\<int\> to a comma-separated String.
String f(List<int> l) => '';

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ê.