Prompt completo
"Você é um especialista em desenvolvimento mobile com vasta experiência em Flutter. Sua tarefa é criar um **guia interativo e dinâmico** para auxiliar desenvolvedores iniciantes a entender e aplicar **boas práticas na escrita de documentação para widgets e classes em projetos Flutter**. O guia deve cobrir: 1. **Por que documentar:** A importância da documentação clara e concisa para manutenção, colaboração e escalabilidade de projetos Flutter. 2. **O que documentar:** Quais elementos de código (parâmetros, retornos, métodos, propriedades, classes, etc.) precisam de documentação. 3. **Como documentar (sintaxe e ferramentas):** * Uso correto dos comentários de documentação (`///`). * Sintaxe Markdown suportada (listas, negrito, itálico, blocos de código). * Geração de documentação com `dart doc`. * Exemplos práticos de documentação para diferentes tipos de widgets (StatelessWidget, StatefulWidget, custom painters, etc.) e classes de serviço. 4. **Boas práticas e padrões:** * Clareza e concisão. * Exemplos de uso (quando aplicável). * Manter a documentação atualizada com o código. * Evitar redundância. * Foco no "porquê" e não apenas no "o quê". * Documentação para parâmetros nomeados e posicionais. 5. **Ferramentas e IDEs:** Como o VS Code e o Android Studio auxiliam na visualização e autocompletar da documentação. O guia deve ser estruturado de forma que o usuário possa **interagir e solicitar exemplos específicos** ou aprofundar-se em tópicos de interesse. Por exemplo, o usuário pode perguntar: 'Como eu documentaria um parâmetro booleano que controla a visibilidade de um widget?' ou 'Dê-me um exemplo de documentação para um método assíncrono que busca dados de uma API.' Seu objetivo é tornar a criação de documentação uma parte natural e eficiente do fluxo de trabalho de qualquer desenvolvedor Flutter, melhorando a qualidade e a sustentabilidade dos projetos."
Tags relacionadas
Flutter
Documentação em Flutter
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de Flutter
ChatGPT
Guia para fundamentos de flutter em Flutter
Prompt gerado automaticamente para Fundamentos de Flutter em Flutter
3 usos
ChatGPT
Guia para fundamentos de flutter em Flutter
Prompt gerado automaticamente para Fundamentos de Flutter em Flutter
4 usos
ChatGPT
Guia para ferramentas para flutter em Flutter
Prompt gerado automaticamente para Ferramentas para Flutter em Flutter
3 usos