Documentação do código
Mantenha seu código bem documentado com suporte para o famoso formato Doxygen.
Visualize a documentação
Consulte a visualização da documentação do Doxygen no pop-up Quick Documentation (Ctrl+Q). Os comandos do Doxygen são analisados e alinhados de maneira visualmente agradável junto com as informações de tipo.
Se parâmetros de função forem documentados separadamente da descrição da função, o CLion mesclará todos os comentários e mostrará a documentação completa de assinatura da função (assim como o Doxygen faz ao gerar a saída).
Renomeie com segurança
Para manter a documentação correta, use a refatoração Rename Shift+F6 para atualizar o nome da função ou seus parâmetros. O CLion atualizará os comentários do Doxygen, além de outras referências.
Use complementação
Para ajudar você a digitar com mais rapidez, o CLion inclui preenchimento automático de comandos e parâmetros de função do Doxygen.
Gere a documentação
Para adicionar um novo comentário Doxygen para uma função, basta gerá-lo. Digite /**, /*!, /// ou //! e pressione Enter. Um stub será gerado para você se a sua função tiver parâmetros, retornar um valor ou lançar uma exceção.
Documentação rápida
- Detalhes da assinatura da função.
- Documentação do código (comentários regulares ou Doxygen).
- Tipos inferidos, que são especialmente valiosos para a linguagem C++ moderna, que pode não ter tipos explícitos.
- O tamanho do tipo.
- Substituições de macros para ajudar você a entender melhor e depurar macros aninhadas.
- Valores de expressões constantes.
- Valor de
Enumcomo um número inteiro.