Estratégias de documentação em react native em React Native
Prompt gerado automaticamente para Documentação em React Native em React Native
"Você é um engenheiro de software sênior com vasta experiência em desenvolvimento mobile e arquitetura de software. Sua tarefa é criar um modelo de documentação abrangente e fácil de usar para componentes React Native, focado em **otimizar a integração de novos desenvolvedores à equipe e acelerar a manutenção de código existente**.
O modelo deve cobrir os seguintes pontos essenciais, com exemplos práticos ou sugestões de conteúdo para cada um:
1. **Visão Geral do Componente:** Qual é o propósito principal do componente? Onde ele é usado na aplicação?
2. **Props (Propriedades):**
* Nome da prop
* Tipo (TypeScript recomendado, por exemplo: `string`, `number`, `boolean`, `React.FC`, `Array<Object>`, `('primary' | 'secondary')`)
* É opcional ou obrigatória?
* Valor padrão (se houver)
* Descrição detalhada do que a prop faz e quais valores esperados.
* Exemplos de uso.
3. **State (Estado Interno):**
* Quais estados o componente gerencia?
* Tipo de cada estado.
* Como o estado é alterado (funções, eventos)?
* Impacto da mudança de estado no componente.
4. **Métodos/Funções Internas:**
* Nome da função
* Parâmetros (tipo e descrição)
* Retorno (tipo e descrição)
* O que a função faz.
* Quando ela é chamada.
5. **Estilização:**
* Como o componente é estilizado (StyleSheet, styled-components, etc.)?
* Quais propriedades de estilo podem ser sobrescritas ou personalizadas via props?
* Classes ou nomes de estilos importantes para referência.
6. **Dependências:**
* Quais outras bibliotecas ou componentes o componente utiliza?
* Versões relevantes.
7. **Testes:**
* Quais testes existem para o componente (unitários, de integração, snapshot)?
* Como executar os testes.
* Casos de uso críticos cobertos pelos testes.
8
Tags relacionadas
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de React Native
Continue explorando prompts nesta categoria.
Melhores práticas de melhores práticas em react native para React Native
Prompt gerado automaticamente para Melhores práticas em React Native em React Native
Melhores práticas de fundamentos de react native para React Native
Prompt gerado automaticamente para Fundamentos de React Native em React Native
Melhores práticas de melhores práticas em react native para React Native
Prompt gerado automaticamente para Melhores práticas em React Native em React Native