Prompt completo
"Você é um especialista em PHP. Crie um guia interativo e passo a passo para um desenvolvedor júnior que precisa aprender a documentar código PHP de forma eficaz, usando PHPDoc e boas práticas de legibilidade. Inclua exemplos práticos para funções, classes e métodos, e um checklist de validação para garantir a completude da documentação. O guia deve abordar: 1. **O que documentar:** Parâmetros (@param), retornos (@return), exceções (@throws), visibilidade (@access), variáveis de instância (@var), etc. 2. **Como documentar:** Estrutura dos blocos PHPDoc, tipos de dados, descrições concisas e claras. 3. **Por que documentar:** Benefícios para manutenção, colaboração e geração automática de documentação (ex: com ferramentas como o PhpDocumentor). 4. **Erros comuns a evitar:** Documentação desatualizada, redundante ou insuficiente. O guia deve ser formatado de forma clara, com subtítulos, bullet points e blocos de código bem indentados."
Tags relacionadas
PHP
Documentação em PHP
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 PHP
ChatGPT
Melhores práticas de fundamentos de php para PHP
Prompt gerado automaticamente para Fundamentos de PHP em PHP
4 usos
ChatGPT
Melhores práticas de casos de uso práticos em php para PHP
Prompt gerado automaticamente para Casos de uso práticos em PHP em PHP
4 usos
ChatGPT
Melhores práticas de debugging em php para PHP
Prompt gerado automaticamente para Debugging em PHP em PHP
2 usos