🔧
ChatGPT intermediate

Como otimizar documentação em c++ em C++

Prompt gerado automaticamente para Documentação em C++ em C++

2 usos C++

Prompt completo

"Você é um engenheiro de software sênior com vasta experiência em C++ e documentação de código. Sua tarefa é criar um guia interativo para desenvolvedores C++ iniciantes, focado em boas práticas para escrever comentários de código (inline e block), docstrings (para funções, classes e módulos usando Doxygen ou similar), e como manter a documentação técnica atualizada com o ciclo de vida do desenvolvimento. O guia deve abordar:

1. **Quando e o que comentar:** Exemplos práticos de cenários onde comentários são essenciais (lógica complexa, otimizações, suposições, etc.) e o que evitar (código óbvio).
2. **Estilos e formatação:** Padrões recomendados para comentários de linha única, blocos de comentários e docstrings, incluindo exemplos de tags Doxygen comuns (@param, @return, @brief, @see, etc.).
3. **Ferramentas e automação:** Uma breve introdução a ferramentas como Doxygen e Sphinx (com Breathe para C++) e como integrá-las ao processo de build (e.g., CMake).
4. **Manutenção da documentação:** Estratégias para garantir que a documentação permaneça consistente e precisa conforme o código evolui (e.g., 'documentação como código', testes de documentação, revisões de código focadas em documentação).
5. **Exemplos práticos:** Forneça trechos de código C++ (com exemplos de classes, funções e talvez um pequeno módulo) demonstrando a aplicação dessas boas práticas.

O guia deve ser didático, claro, conciso e prático, focado em ajudar o desenvolvedor iniciante a entender a importância e 'como fazer' uma documentação eficaz em projetos C++."

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