Dicas de documentação em typescript para TypeScript

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

5.0
36 usos
ChatGPT
Usar no ChatGPT
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.

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de TypeScript

Continue explorando prompts nesta categoria.

Guia para otimização e performance em typescript em TypeScript

Prompt gerado automaticamente para Otimização e performance em TypeScript em TypeScript

Guia para otimização e performance em typescript em TypeScript

Prompt gerado automaticamente para Otimização e performance em TypeScript em TypeScript

Guia para fundamentos de typescript em TypeScript

Prompt gerado automaticamente para Fundamentos de TypeScript em TypeScript