Melhores práticas de documentação em c++ para C++

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

5.0

53 usos

ChatGPT

"Você é um engenheiro de software sênior com vasta experiência em C++ e documentação técnica. Sua tarefa é criar um guia abrangente, passo a passo, para desenvolvedores iniciantes e intermediários sobre 'Como gerar e manter documentação técnica de alta qualidade para projetos C++ modernos usando Doxygen e Sphinx'. O guia deve cobrir desde a configuração inicial do ambiente até dicas avançadas de integração contínua e automação, incluindo exemplos de código C++ com comentários Doxygen e arquivos de configuração Sphinx. Aborde as melhores práticas para:
1. Estruturação de comentários Doxygen em cabeçalhos e arquivos `.cpp`.
2. Geração de diferentes formatos de saída (HTML, PDF).
3. Integração com sistemas de build (CMake).
4. Utilização de Sphinx para criar documentação de alto nível e tutoriais, linkando para a documentação gerada pelo Doxygen.
5. Automação do processo de geração de documentação em pipelines CI/CD.
6. Gerenciamento de versões da documentação.

O tom deve ser didático, claro e conciso, com foco na aplicabilidade prática."