Dicas de documentação em java para Java
Prompt gerado automaticamente para Documentação em Java em Java
5.0
37 usos
ChatGPT
"Você é um especialista em desenvolvimento de software Java e documentação técnica. Sua tarefa é criar um guia interativo passo a passo para um desenvolvedor júnior que precisa gerar a documentação Javadoc para um projeto Java existente, utilizando ferramentas de linha de comando (CLI) e IDEs (IntelliJ IDEA e Eclipse). O guia deve incluir:
1. **Pré-requisitos:** O que o desenvolvedor precisa ter instalado ou configurado.
2. **Boas Práticas de Comentários:** Exemplos de como escrever comentários Javadoc eficazes para classes, métodos e campos, cobrindo `@param`, `@return`, `@throws`, `@see`, `@since`, `@deprecated`.
3. **Geração via CLI:** Comandos exatos e explicações para gerar a documentação Javadoc a partir de um projeto simples com uma estrutura de diretórios padrão.
4. **Geração via IntelliJ IDEA:** Passos detalhados e capturas de tela (ou descrições claras de cliques e menus) para gerar o Javadoc.
5. **Geração via Eclipse:** Passos detalhados e capturas de tela (ou descrições claras de cliques e menus) para gerar o Javadoc.
6. **Configurações Avançadas (Opcional):** Como incluir arquivos CSS personalizados, excluir pacotes específicos ou adicionar um título ao documento gerado.
7. **Resolução de Problemas Comuns:** O que fazer se o Javadoc não gerar, se houver erros de codificação, ou se links estiverem quebrados.
O tom deve ser didático, encorajador e extremamente claro, como se estivesse explicando para alguém sem experiência prévia com Javadoc. O guia deve ser otimizado para fácil leitura e compreensão, talvez usando listas numeradas, bullet points e blocos de código formatados. O objetivo final é que o desenvolvedor júnior consiga gerar a documentação Javadoc completa e funcional para qualquer projeto Java após seguir este guia."
Tags relacionadas
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.
Outros prompts de Java
Continue explorando prompts nesta categoria.
Guia para debugging em java em Java
Prompt gerado automaticamente para Debugging em Java em Java
Guia para otimização e performance em java em Java
Prompt gerado automaticamente para Otimização e performance em Java em Java
Guia para fundamentos de java em Java
Prompt gerado automaticamente para Fundamentos de Java em Java