Refactorización de código mediante Chat en línea de Copilot de GitHub

6 minutos

Comprende tu código

Antes de refactorizar el código, es importante comprender el código con el que trabaja. Debe comprender el propósito del código, cómo funciona y las dependencias que puede tener. Si no está familiarizado con el código, dedique algún tiempo a leerlo y comprender su estructura y lógica. El uso de GitHub Copilot para analizar el código puede ayudarle a identificar áreas para mejorar y sugerir opciones de refactorización.

Puede usar la característica Chat en línea para formular preguntas sobre el código, obtener explicaciones de partes específicas o solicitar sugerencias para mejorar. Por ejemplo, puede pedir a GitHub Copilot que explique cómo funciona una función determinada o sugerir maneras de optimizarla. También puede usar la característica Chat en línea para solicitar ayuda con tareas de codificación específicas, como refactorizar una función o mejorar la legibilidad del código.

Estos son algunos ejemplos de mensajes que solicitan a GitHub Copilot ayuda con el código:

/explain Explain how authentication is implemented in this code
/explain Can this code be updated to improve security? Explain the concepts and show some examples

Si la explicación es larga o compleja, puede pasar a la vista Chat para continuar la conversación. También puede usar la vista Chat para hacer preguntas de seguimiento o solicitar información adicional.

Usar chat en línea para refactorizar código

Use la característica Chat en línea cuando quiera refactorizar una sección de código que realiza una tarea específica. Para cambios más complejos que implican actualizar varios archivos o proyectos, use uno de los modos de vista chat.

Para refactorizar el código mediante Chat en línea, siga estos pasos:

Abra el archivo que contiene el código que desea optimizar.
Seleccione el código que desea optimizar.
Abra una sesión de chat en línea.

Use el método abreviado de teclado Ctrl+I para abrir la sesión chat en línea. Como alternativa, puede seleccionar Editor Inline Chat en uno de los menús de GitHub Copilot.
Escriba un mensaje que solicite una optimización.

Por ejemplo: ¿Se puede mejorar este código?
Revise la actualización de código sugerida.

Copilot aplica la actualización de código sugerida directamente en el editor, donde puede revisarla con el contexto completo del código circundante.
Seleccione Aceptar o Cerrar para aceptar o descartar la actualización de código sugerida.

Al igual que con todas las sugerencias de Copilot, compruebe que el código revisado se ejecuta sin errores y genera el resultado correcto.

En el ejemplo siguiente se muestra cómo usar El chat en línea para refactorizar un método de C# que procesa los datos.

El método original realiza la limpieza de datos, construye una tabla de datos y, a continuación, imprime el contenido de la tabla. La combinación de varias operaciones en un método dificulta el mantenimiento y la prueba del código.

Para refactorizar el método original, pida a Inline Chat que cree métodos independientes para cada una de las tareas realizadas en el método original.

Este es el código original:

using System;
using System.Data;

public class DataProcessor
{
    public void ProcessData(string item, string price)
    {
        // Cleanse the data
        item = item.Trim();    // Remove leading and trailing whitespace
        price = price.Trim();  // Remove leading and trailing whitespace
        double priceValue = double.Parse(price);   // Convert price to a double
        // More cleansing operations can be added here

        // Create and print a DataTable
        DataTable table = new DataTable();
        table.Columns.Add("Item", typeof(string));
        table.Columns.Add("Price", typeof(double));
        table.Rows.Add(item, priceValue);
        foreach (DataRow row in table.Rows)
        {
            Console.WriteLine($"Item: {row["Item"]}, Price: {row["Price"]}");
        }
    }
}

// Example usage
class Program
{
    static void Main()
    {
        string item = "  Apple  ";
        string price = "  1.50  ";
        var processor = new DataProcessor();
        processor.ProcessData(item, price);
    }
}

Para refactorizar el método ProcessData, siga estos pasos:

Seleccione el método ProcessData.
Abra el chat en línea.
Escriba un mensaje que pida a Copilot que cree métodos independientes para cada tarea y presione Entrar.

Por ejemplo: Quiero refactorizar el método ProcessData. Quiero un método para la limpieza de datos, un método para imprimir y un método para el procesamiento de datos.

Revise la actualización de código sugerida.

En este ejemplo, Copilot sugiere una versión refactorizado del método original que separa las tareas de limpieza e impresión en métodos independientes.

using System;
using System.Data;

public class DataProcessor
{
    public void ProcessData(string item, string price)
    {
        (string cleansedItem, double cleansedPrice) = CleanseData(item, price);
        DataTable table = new DataTable();
        table.Columns.Add("Item", typeof(string));
        table.Columns.Add("Price", typeof(double));
        table.Rows.Add(cleansedItem, cleansedPrice);
        PrintData(table);
    }

    private (string, double) CleanseData(string item, string price)
    {
        string trimmedItem = item.Trim();
        string trimmedPrice = price.Trim();
        double priceValue = double.Parse(trimmedPrice);
        return (trimmedItem, priceValue);
    }

    private void PrintData(DataTable table)
    {
        foreach (DataRow row in table.Rows)
        {
            Console.WriteLine($"Item: {row["Item"]}, Price: {row["Price"]}");
        }
    }
}

// Example usage
class Program
{
    static void Main()
    {
        string item = "  Apple  ";
        string price = "  1.50  ";
        var processor = new DataProcessor();
        processor.ProcessData(item, price);
    }
}

En este ejemplo, la refactorización del código original mejora la modularidad y facilita la comprensión del código.

Seleccione Aceptar o Cerrar para aceptar o descartar la actualización de código sugerida.

En este ejemplo, el código sugerido es bueno, por lo que debe seleccionar Aceptar para aplicar el código refactorizado al proyecto.

Al igual que con todas las sugerencias de Copilot, compruebe que el código revisado se ejecuta sin errores y genera el resultado correcto.
Pruebe el código refactorizado para asegurarse de que se ejecuta sin errores y genera el resultado esperado.

Resumen

La característica Chat en línea de GitHub Copilot le permite refactorizar el código directamente en el editor de código. El chat en línea es útil cuando desea realizar cambios en el código sin tener que cambiar a la vista Chat. Puede usar Chat en línea para solicitar ayuda con tareas de codificación específicas, como refactorizar una función o mejorar la legibilidad del código. También puede usar Chat en línea para evaluar el código existente antes de refactorizar.

Comentarios

¿Le ha resultado útil esta página?