Dicas de documentação em c++ para C++
Prompt gerado automaticamente para Documentação em C++ em C++
5.0
34 usos
ChatGPT
"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
Como Usar este Prompt
1
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
2
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
3
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de C++
Continue explorando prompts nesta categoria.
Melhores práticas de padrões de design em c++ para C++
Prompt gerado automaticamente para Padrões de design em C++ em C++
Melhores práticas de documentação em c++ para C++
Prompt gerado automaticamente para Documentação em C++ em C++
Melhores práticas de melhores práticas em c++ para C++
Prompt gerado automaticamente para Melhores práticas em C++ em C++