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

  • 5 minutos

O GitHub Copilot facilita o trabalho dos desenvolvedores com código complexo ou desconhecido. No Visual Studio Code, os desenvolvedores têm acesso direto aos recursos do GitHub Copilot que analisam, explicam ou documentam código.

Analisar e explicar o código usando o GitHub Copilot

Os seguintes recursos do 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 o GitHub Copilot

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

  • Modo de consulta: use o modo de consulta para sugerir a documentação de código inline 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 edição: use o modo de edição para sugerir a documentação de código embutido para um arquivo de código, classe ou método. Examine a documentação sugerida no editor, navegando entre as atualizações sugeridas. Aceite ou rejeite sugestões individuais ou modifique as sugestões conforme necessário.

  • Modo de agente: use o modo de agente 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 o GitHub Copilot

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

  • Modo de exibição de chat no modo Pergunta: Use o modo Pergunta para analisar a base de código e entender os projetos de código, arquivos e classes. Use o modo de solicitação 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).

  • Visualização de chat no modo de edição: gerar um arquivo de documentação do projeto (README.md).

  • Modo de exibição de chat no modo de 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, o GitHub Copilot pode fazer várias solicitações premium para concluir uma única tarefa. Solicitações premium podem ser usadas por prompts iniciados pelo usuário e ações de acompanhamento que o Copilot realiza em seu nome. O total de solicitações premium usadas dependerá da complexidade da tarefa, do número de etapas envolvidas e do modelo selecionado.

Resumo

O 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 do Visual Studio Code.