🔧
ChatGPT intermediate

Dicas de documentação em c++ para 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 técnica. Sua tarefa é criar um modelo de documentação para funções e classes C++ que seja ao mesmo tempo conciso, informativo e fácil de manter, visando acelerar o onboarding de novos desenvolvedores em projetos complexos. O modelo deve incluir campos essenciais como propósito, parâmetros (tipo, nome, descrição, exemplo), valor de retorno, pré-condições, pós-condições, tratamento de erros/exceções e exemplos de uso. Gere este modelo em formato de template markdown, com placeholders claros para cada seção, e adicione uma breve justificativa para a inclusão de cada campo, explicando como ele contribui para a clareza e manutenibilidade da documentação."

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