Pular para o conteúdo principal

missing_code_block_language_in_doc_comment

Saiba mais sobre a regra de lint missing_code_block_language_in_doc_comment.

Estável
Lançado no Dart 3.4

Um bloco de código não tem a linguagem especificada.

Detalhes

#

FAÇA especifique a linguagem usada no bloco de código de um comentário de documentação.

Para habilitar o destaque de sintaxe adequado dos blocos de código Markdown, o dart doc recomenda fortemente que os blocos de código especifiquem a linguagem usada logo após a abertura do bloco de código.

Consulte o highlight.js para ver a lista de linguagens suportadas pelo dart doc. Para desabilitar o destaque de sintaxe, ou se nenhuma linguagem for adequada, você pode especificar none como linguagem.

RUIM:

dart
/// ```
/// void main() {}
/// ```
class A {}

BOM:

dart
/// ```dart
/// void main() {}
/// ```
class A {}

Ativar

#

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

analysis_options.yaml
yaml
linter:
  rules:
    - missing_code_block_language_in_doc_comment

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

analysis_options.yaml
yaml
linter:
  rules:
    missing_code_block_language_in_doc_comment: true

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