Prompt completo
Crie um guia interativo e passo a passo para desenvolvedores iniciantes, explicando como adicionar e manter comentários e documentação em consultas SQL complexas. O guia deve abordar: 1. **Melhores práticas:** Onde e como inserir comentários de forma eficaz (ex: comentários de linha, blocos de cabeçalho para consultas grandes, documentação de parâmetros de funções de tabela). 2. **Ferramentas e técnicas:** Exemplos práticos usando diferentes dialetos SQL (SQL Server, PostgreSQL, MySQL) para demonstrar a sintaxe de comentários e como ferramentas de IDE (como SSMS, pgAdmin, DataGrip) podem auxiliar na visualização e manutenção. 3. **Benefícios da documentação:** Enfatize a importância da documentação para a manutenibilidade do código, depuração, onboarding de novos membros da equipe e conformidade com padrões de auditoria. 4. **Exemplos práticos:** Inclua exemplos de consultas SQL reais (hipotéticas, mas complexas) antes e depois da adição de documentação, mostrando a melhoria na legibilidade e compreensão. 5. **Dicas para evitar armadilhas:** Alerte sobre comentários desatualizados, excesso de comentários óbvios e a importância de manter a documentação sincronizada com as mudanças no código. O objetivo é que o guia seja prático, acionável e ajude o desenvolvedor a transformar consultas SQL "caóticas" em código bem documentado e fácil de entender.
Tags relacionadas
Consultas SQL
Documentação em Consultas SQL
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 Consultas SQL
ChatGPT
Prompt para casos de uso práticos em consultas sql em Consultas SQL
Prompt gerado automaticamente para Casos de uso práticos em Consultas SQL em Consultas SQL
3 usos
ChatGPT
Melhores práticas de casos de uso práticos em consultas sql para Consultas SQL
Prompt gerado automaticamente para Casos de uso práticos em Consultas SQL em Consultas SQL
3 usos
ChatGPT
Guia para padrões de design em consultas sql em Consultas SQL
Prompt gerado automaticamente para Padrões de design em Consultas SQL em Consultas SQL
4 usos