057 – dartdoc e Documentação de Bibliotecas em Dart – Curso Gratuito de DART

Playlist: Curso Grátis de FLUTTER e DART Completo

dartdoc

O comando dartdoc cria documentação de referência da API a partir do código-fonte do Dart. Você pode adicionar descrições à documentação gerada usando comentários de documentação, que podem conter formatação de marcação. Para obter orientação sobre como escrever comentários do documento, consulte a parte de documentação do Efetivo Dart.

Execute o dartdoc no diretório raiz do seu pacote. Por exemplo:

  cd my_app
  dartdoc
Documentando my_app …
…
Sucesso! Documentos gerados em / Users / me / projects / my_app / doc / api
Por padrão, os arquivos de documentação são arquivos HTML estáticos, colocados no diretório doc / api. Para visualizar a documentação renderizada, você precisa de um servidor HTTP.

Embora o dartdoc esteja no DART SDK, também está disponível no pacote dartdoc. Você pode usar o pacote quando precisar de uma interface programática ou quando quiser testar recursos que ainda não estão na versão do dartdoc do SDK.

Para obter informações sobre opções de linha de comando, use o sinalizador –help:

  dartdoc –help