🔷
ChatGPT intermediate

Dicas de documentação em typescript para TypeScript

Prompt gerado automaticamente para Documentação em TypeScript em TypeScript

2 usos TypeScript

Prompt completo

Crie um guia interativo e autoexplicativo (passo a passo) para um desenvolvedor júnior que está começando em TypeScript. O guia deve abordar as melhores práticas para a escrita de documentação de código em TypeScript, especificamente focando em:

1.  **Comentários de código:** Quando e como usar comentários eficazes (JSDoc-style, com tipos explícitos para parâmetros e retornos) para funções, classes, interfaces e tipos. Inclua exemplos de tags JSDoc comuns (`@param`, `@returns`, `@typedef`, `@example`, `@deprecated`).
2.  **Documentação de API (geração automática):** Explique o papel de ferramentas como TypeDoc e como configurá-las para gerar documentação a partir dos comentários JSDoc. Mostre um exemplo simples de configuração e a estrutura de saída gerada.
3.  **Documentação externa (READMEs, Wikis):** Dê dicas sobre o que incluir em arquivos README.md para projetos TypeScript (instalação, uso básico, estrutura de pastas, scripts importantes) e como manter a consistência entre a documentação interna (comentários) e externa.

O guia deve ser prático, com exemplos de código claros e concisos, e focar em como a documentação bem feita melhora a manutenibilidade, a colaboração e a curva de aprendizado em projetos TypeScript. Utilize uma linguagem acessível e didática.

Tags relacionadas

TypeScript Documentação em TypeScript 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