Hands-on: desenvolvendo e criando documentações técnicas com Github Copilot
por Lucas de Faria Polaquini, Especialista em Engenharia de Tecnologia no Itaú
No último artigo, abordamos toda a teoria por trás da ferramenta Github Copilot, uma poderosa aplicação desenvolvida pela OpenAI, em parceria com a GitHub, capaz de acelerar processos de programação e até de documentação técnica. Nele, também te ensinamos como configurar a ferramenta e dar os seus primeiros passos com ela.
Já leu o primeiro e absorveu esse contexto? Então agora vamos entender como ele se aplica na prática, em um hands-on que se propõe a simular a criação de uma função simples, que tem o objetivo de calcular um número médio da soma de dois valores, além de criar uma documentação para ela.
GtHub Copilot em ação
Quando começamos a escrever a documentação de um método, o Copilot pode sugerir uma explicação para o que ele faz, como no exemplo a seguir:
No exemplo, iniciamos criando um arquivo/classe. Não iremos nos prender a qual tecnologia será usada — afinal, como falamos no artigo anterior, o Copilot foi treinado em múltiplas linguagens e dá conta do recado!
Notem que, neste caso, criamos uma classe em C# e começamos a escrever um summary para a função. A ideia neste ponto é descrever o que a função fará, para munirmos o Copilot com as informações necessárias.
Conforme vamos escrevendo, ele começa a entender e fazer predições mais assertivas:
Neste ponto, a ferramenta já entendeu a lógica da nossa aplicação e é capaz de sugerir de forma automática a linha para o segundo parâmetro.
Agora, ao começarmos a digitar o retorno, ela já fez uma sugestão com base nas informações que ele possui. Incrível, né? Mas acreditem, a mágica ainda está por vir!
Com base na documentação, o Copilot nos sugere a função pronta. E de quebra, ainda temos uma parte do código documentada. Abaixo, compartilhamos a documentação gerada pela ferramenta:
Ou seja, agora, quanto mais clara e bem escrita nossa documentação estiver, além de ajudarmos todas as pessoas de engenharia que forem trabalhar com o código futuramente, também teremos as melhores sugestões do Copilot.
Agora, iremos criar um README.md para nosso projeto. E adivinha? O Copilot também é capaz de nos ajudar com isso.
Para começar, vamos criar nosso README.md e iniciar nosso trabalho. Neste exemplo, coloquei no início um título para o repositório. A seguir, a mágica começa a acontecer. Percebam que já começamos com sugestões da ferramenta:
Um ponto importante: apesar do potencial do Copilot, a ferramenta precisa que você a guie para o caminho correto. Então, neste começo descrevemos de uma forma bem breve o objetivo da função. Dessa forma, podemos receber sugestões mais assertivas.
Como demonstrado no exemplo abaixo, a partir da descrição, o Copilot já começa a entender o contexto e sugerir de forma assertiva pontos relevantes para a documentação.
Conforme passamos para os próximos passos, ele passa a sugerir uma ordem de informações e tópicos para nosso README.
Seguindo esse fluxo, temos uma documentação clara e objetiva sobre a função — tudo com o auxílio do Copilot.
Vale lembrar que a ferramenta deve ser usada como suporte, e não como fórmula mágica. Ela não irá trabalhar de forma efetiva se você não for capaz de muni-la com as informações mais relevantes para que ela seja executada.
Como demonstrado, o Copilot pode ser uma ferramenta valiosa para a escrita de códigos e documentações. Com o auxílio do assistente de codificação, você pode aumentar a produtividade, reduzir erros, facilitar a escrita de documentações e gerar exemplos de uso de funções e métodos em seus códigos.
Você já utilizou o Copilot ou aplica a ferramenta no seu dia a dia? Compartilhe com a gente as suas percepções nos comentários! Tem alguma dúvida sobre o conteúdo ou gostaria de ler sobre algum outro tema por aqui? Pode dividir com a gente também para continuarmos a nossa conversa. ;)
