slash_ for_ doc_ comments
Saiba mais sobre a regra de lint slash_for_doc_comments.
Prefira usar /// para comentários de documentação.
Detalhes
#Do Effective Dart:
FAÇA usar /// para comentários de documentação.
Embora o Dart suporte duas sintaxes de comentários de documentação (/// e /**),
preferimos usar /// para comentários de documentação.
BOM:
/// Parses a set of option strings. For each option:
///
/// * If it is `null`, then it is ignored.
/// * If it is a string, then [validate] is called on it.
/// * If it is any other type, it is *not* validated.
void parse(List options) {
// ...
}
Dentro de um comentário de documentação, você pode usar markdown para formatação.
Ativar
#
Para ativar a regra slash_for_doc_comments, adicione slash_for_doc_comments
em
linter > rules no seu arquivo analysis_options.yaml:
linter:
rules:
- slash_for_doc_comments
Se você usa a sintaxe de mapa YAML para configurar as regras de lint,
adicione slash_for_doc_comments: true em linter > rules:
linter:
rules:
slash_for_doc_comments: true
Salvo indicação em contrário, a documentação neste site reflete Dart 3.13.7. Relatar um problema.
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ê.