Examinar os recursos de "explicar" e "documento" do GitHub Copilot

  • 5 minutos

GitHub Copilot torna mais fácil para os desenvolvedores trabalhar com código complexo ou desconhecido. Em Visual Studio Code, os desenvolvedores têm acesso direto a GitHub Copilot recursos que analisam, explicam ou documentam código.

Analisar e explicar o código usando GitHub Copilot

Os seguintes recursos de GitHub Copilot podem ser usados para analisar e explicar o código:

  • Modo de pergunta: use a exibição de Chat no modo de pergunta para analisar todo o workspace e fazer perguntas sobre tópicos de codificação, conceitos de tecnologia e práticas gerais de programação.

  • Chat embutido: inicie uma sessão de chat embutida diretamente do editor para perguntar sobre seções de código específicas.

  • Ações Inteligentes: execute a ação Explicar inteligente para explicar o código selecionado sem precisar escrever um prompt.

  • Chat Rápido: Faça uma pergunta rápida e volte ao que você está fazendo.

Gerar documentação de código embutido usando GitHub Copilot

Os seguintes recursos de GitHub Copilot podem ser usados para gerar a documentação de código embutido:

  • Modo de pergunta: use o modo Agente de Perguntas para sugerir a documentação de código em linha para um arquivo de código, classe ou método. Revise a documentação embutida sugerida no modo de exibição de chat. Solicite atualizações conforme necessário na conversa de chat. Depois de estar satisfeito com a documentação proposta, você poderá inserir a documentação sugerida no arquivo de código correspondente.

  • Modo de plano: use o modo Plano para criar um plano de implementação detalhado para suas tarefas de documentação. O modo Plano pode ser usado para analisar a base de código, identificar os requisitos de documentação e produzir um plano passo a passo. Depois que o plano for aprovado, você poderá entregá-lo ao modo agent para execução.

  • Modo de agente: use o modo Agent para gerar a documentação de código embutido de forma autônoma para projetos, arquivos, classes ou métodos de código especificados. Faça com que o agente execute outras tarefas durante ou após o processo de documentação. Aceite ou rejeite as atualizações quando o agente finalizar as tarefas atribuídas.

  • Chat embutido – Use uma sessão de chat embutida para funcionar diretamente no editor de código. O chat embutido é útil quando você deseja documentar código específico (classes, métodos ou blocos de código) sem sair do editor. Você pode fornecer instruções específicas no prompt ou usar o comando de barra /doc sem informações específicas, se desejar. As atualizações são exibidas no editor de código e podem ser aceitas ou rejeitadas. Você também pode escolher a opção para executar novamente o prompt com ou sem atualizações.

  • Ação inteligente Gerar Docs: Use a ação inteligente Gerar Docs para gerar documentação de código inline para uma classe, método ou bloco de código selecionado. A ação inteligente Gerar Documentos é útil quando você não tem requisitos específicos que exigiriam um prompt. As atualizações são exibidas no editor de código e podem ser aceitas ou rejeitadas. Você também pode executar novamente a ação inteligente.

Gerar documentação do projeto usando GitHub Copilot

Os seguintes recursos de GitHub Copilot podem ser usados para gerar a documentação do projeto:

  • Modo de exibição do chat no Ask Agent: use o Ask Agent para analisar a base de código e obter uma compreensão dos projetos de código, arquivos e classes. O agente Ask pode ser usado para visualizar a documentação sugerida do projeto. Reveja as sugestões e solicite atualizações ou outros detalhes conforme necessário. Insira a documentação sugerida em um arquivo de documentação do projeto (README.md).

  • Visão de chat no modo de agente de planejamento: crie um plano de implementação detalhado para a documentação do projeto e, em seguida, entregue para o modo de agente para execução.

  • Modo de exibição de chat no modo agente: gere uma coleção de arquivos de documentação do projeto: crie/atualize o README.md, crie/atualize o UsageExamples.md e crie/atualize o ChangeLog.md. Inclua links entre os arquivos de documentação, classes e métodos de referência cruzada e garanta a consistência entre documentos.

Importante

Quando você usa a exibição chat no modo de agente, cada prompt que você insere conta como uma solicitação premium, multiplicada pelo multiplicador do modelo. GitHub Copilot pode executar várias ações de acompanhamento para concluir sua tarefa, mas essas ações de acompanhamento não contam para o uso da solicitação premium. Somente os comandos inseridos são cobrados. O total de solicitações premium usadas depende de quantos prompts você inserir e de qual modelo for selecionado. O Plano Gratuito para GitHub Copilot obtém 50 solicitações premium por mês. Verifique as descrições do plano para obter mais detalhes sobre os limites de solicitação premium para cada assinatura GitHub Copilot.

Resumo

GitHub Copilot ajuda você a analisar e documentar seu código de forma rápida e precisa. O modo de exibição de chat, o chat embutido, o chat rápido e os recursos de ação inteligente fornecem vários níveis de interação diretamente no ambiente Visual Studio Code.