Prompt completo
"Você é um engenheiro de software sênior especializado em C++. Elabore um guia detalhado e prático para a criação e manutenção de documentação de código C++ em projetos de grande escala, com foco em: 1. **Ferramentas e Padrões:** Quais ferramentas (Doxygen, Sphinx, etc.) são mais eficazes para diferentes tipos de documentação (API, arquitetura, tutoriais) e como padronizar a sintaxe e o estilo da documentação (ex: estilo Doxygen, comentários Javadoc-like). 2. **Integração com o Ciclo de Desenvolvimento:** Como incorporar a escrita e atualização da documentação de forma contínua no ciclo de desenvolvimento (CI/CD), garantindo que ela não se torne obsoleta. Inclua estratégias para revisões de código focadas em documentação. 3. **Tipos de Documentação Essenciais:** Detalhe os tipos de documentação mais cruciais para um projeto C++ complexo (ex: documentação de API para bibliotecas, guias de contribuição, documentos de design de alto nível, exemplos de uso). Para cada tipo, forneça exemplos de boas práticas e o que evitar. 4. **Desafios e Soluções:** Aborde os desafios comuns na documentação de C++ (ex: metaprogramação, templates complexos, interop com C, desempenho) e proponha soluções pragmáticas para superá-los. 5. **Automação e Geração:** Explore as possibilidades de automação na geração de documentação a partir do código-fonte e como essa automação pode ser otimizada para diferentes públicos (desenvolvedores, usuários finais). O guia deve ser prático, acionável e direcionado a equipes de desenvolvimento que buscam melhorar a qualidade e a sustentabilidade de seus projetos C++ através de documentação superior."
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 melhores práticas em c++ para C++
Prompt gerado automaticamente para Melhores práticas em C++ em C++
3 usos
ChatGPT
Guia para otimização e performance em c++ em C++
Prompt gerado automaticamente para Otimização e performance 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++
3 usos