Usando o documentador de código de IA
Escrito para a interface antiga
Este artigo foi escrito para a interface antiga. As instruções ainda podem ser usadas, mas as capturas de tela estão desatualizadas. Em alguns casos, os itens referenciados nas instruções foram movidos ou alterados. Se você não conseguir encontrar um item, consulte o Para onde foi artigo.
Visão geral
Este artigo explica como usar o AI Code Documenter para gerar automaticamente documentação de um componente selecionado. Ele ajuda as equipes a criar documentação de código clara e bem estruturada, que você pode fazer commit na branch.
Limitações padrão da IA
Por padrão, a Flosum fornece um modelo de IA DeepSeek compartilhado e gratuito para DevOps por meio da API da DeepSeek. Como ele é compartilhado entre tenants, o desempenho e a disponibilidade dependem da carga do sistema e da capacidade de tokens. Durante o uso intenso, você pode ver maior latência ou erros temporários. Para evitar isso, você pode adicionar seu próprio modelo de IA personalizado. Veja o artigo a seguir.
Melhores práticas
Execute o AI Code Documenter em código estável para evitar regenerar comentários repetidamente.
Revise sempre os comentários da IA antes de fazer commit para garantir precisão e terminologia correta.
Faça commit em pequenos blocos lógicos para manter a revisão e o rollback simples.
Usando o AI Code Documenter
Criar documentação
Clique em Ferramentas de IA ao lado de Editar.
Clique em AI Code Documenter no menu suspenso.
Enquanto a documentação está sendo gerada, A IA está gerando... é exibido.
Quando o AI Code Documenter terminar, a visualização das diferenças se abre, com o original à esquerda e as alterações da IA à direita.
Revise as alterações e faça as edições necessárias.
Clique em Fazer commit das alterações.
Insira uma mensagem de commit.
Clique em Fazer commit.
Atualizado
Isto foi útil?