type_annotate_public_apis

Anote os tipos das APIs públicas.

Do Effective Dart:

PREFIRA anotar os tipos das APIs públicas.

Anotações de tipo são documentação importante sobre como uma biblioteca deve ser usada. Anotar os tipos de parâmetros e de retorno de métodos e funções públicos ajuda os usuários a entender o que a API espera e o que ela fornece.

Observe que, se uma API pública aceita um intervalo de valores que o sistema de tipos do Dart não consegue expressar, é aceitável deixá-la sem tipo. Nesse caso, o dynamic implícito é o tipo correto para a API.

Para código interno a uma biblioteca (privado, ou coisas como funções aninhadas), anote quando achar que ajuda, mas não sinta que precisa fornecer as anotações.

RUIM:

install(id, destination) {
  // ...
}

Aqui, não fica claro o que é id. Uma string? E destination? Uma string ou um objeto File? Esse método é síncrono ou assíncrono?

BOM:

Future<bool> install(PackageId id, String destination) {
  // ...
}

Com os tipos, tudo isso fica esclarecido.

O lint type_annotate_public_apis é incompatível com as seguintes regras:

• omit_obvious_property_types

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

linter:
  rules:
    - type_annotate_public_apis

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

linter:
  rules:
    type_annotate_public_apis: true