Prompt completo
"Você é um especialista em C++ e documentação de código. Sua tarefa é gerar um guia passo a passo, detalhado e acionável para um desenvolvedor júnior que precisa criar e manter a documentação de um projeto C++ de tamanho médio (contendo bibliotecas externas, testes unitários e um sistema de build CMake). O guia deve cobrir as melhores práticas para: 1) Escolher e configurar uma ferramenta de geração de documentação (como Doxygen ou Sphinx com Breathe/Exhale); 2) Estruturar os comentários no código para máxima legibilidade e extração automática; 3) Documentar APIs públicas (classes, funções, enums, structs) com exemplos de uso; 4) Documentar decisões de design e arquitetura (razões para escolhas, tradeoffs); 5) Manter a documentação sincronizada com o código (estratégias de CI/CD para geração e publicação); e 6) Encorajar a cultura de documentação dentro da equipe. Inclua exemplos de código C++ com os comentários formatados corretamente e exemplos de configuração das ferramentas. O tom deve ser instrutivo e encorajador."
Tags relacionadas
C++
Documentação em C++
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 C++
ChatGPT
Melhores práticas de padrões de design em c++ para C++
Prompt gerado automaticamente para Padrões de design em C++ em C++
4 usos
ChatGPT
Melhores práticas de documentação em c++ para C++
Prompt gerado automaticamente para Documentação em C++ em C++
4 usos
ChatGPT
Melhores práticas de melhores práticas em c++ para C++
Prompt gerado automaticamente para Melhores práticas em C++ em C++
4 usos