Code herstructureren met GitHub Copilot Inline Chat

6 minuten

Inzicht in uw code

Voordat u uw code herstructureren, is het belangrijk om inzicht te hebben in de code waarmee u werkt. U moet weten wat het doel van de code is, hoe deze werkt en eventuele afhankelijkheden die de code kan hebben. Als u niet bekend bent met de code, neemt u enige tijd om deze te lezen en de structuur en logica ervan te begrijpen. Door GitHub Copilot te gebruiken om de code te analyseren, kunt u gebieden voor verbetering identificeren en opties voor herstructureren voorstellen.

U kunt de functie Inline Chat gebruiken om vragen te stellen over de code, uitleg te krijgen over specifieke onderdelen of suggesties voor verbeteringen aan te vragen. U kunt bijvoorbeeld GitHub Copilot vragen om uit te leggen hoe een bepaalde functie werkt of manieren voorstellen om deze te optimaliseren. U kunt ook de functie Inline Chat gebruiken om hulp te vragen bij specifieke coderingstaken, zoals het herstructureren van een functie of het verbeteren van de leesbaarheid van code.

Hier volgen enkele voorbeelden van prompts die GitHub Copilot vragen om hulp bij code:

/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

Als de uitleg lang of complex is, kunt u naar de chatweergave gaan om het gesprek voort te zetten. U kunt ook de chatweergave gebruiken om vervolgvragen te stellen of aanvullende informatie aan te vragen.

Inline Chat gebruiken om code te herstructureren

Gebruik de functie Inline Chat als u een codesectie wilt herstructureren waarmee een specifieke taak wordt uitgevoerd. Gebruik een van de chatweergavemodi voor complexere wijzigingen die betrekking hebben op het bijwerken van meerdere bestanden of projecten.

Volg deze stappen om code te herstructureren met behulp van Inline Chat:

Open het bestand met de code die u wilt optimaliseren.
Selecteer de code die u wilt optimaliseren.
Open een inline chatsessie.

Gebruik de sneltoets Ctrl+I om de inlinechatsessie te openen. U kunt ook Editor Inline Chat selecteren in een van de GitHub Copilot menu's.
Voer een prompt in waarin wordt gevraagd om een optimalisatie.

Bijvoorbeeld: Kan deze code worden verbeterd?
Bekijk de voorgestelde code-update.

GitHub Copilot de voorgestelde code-update rechtstreeks in de editor toepast, waar u deze ter plaatse kunt bekijken, met de volledige context van de omringende code.
Selecteer Accepteren of Sluiten om de voorgestelde code-update te accepteren of te negeren.

Controleer net als bij alle GitHub Copilot suggesties of de herziene code zonder fouten wordt uitgevoerd en het juiste resultaat oplevert.

In het volgende voorbeeld ziet u hoe u Inline Chat gebruikt om een C#-methode te herstructureren waarmee gegevens worden verwerkt.

Met de oorspronkelijke methode worden gegevens opschonen uitgevoerd, wordt een gegevenstabel gemaakt en wordt de inhoud van de tabel afgedrukt. Door verschillende bewerkingen in één methode te combineren, is het moeilijker om uw code te onderhouden en te testen.

U kunt de oorspronkelijke methode herstructureren door Inline Chat te vragen om afzonderlijke methoden te maken voor elk van de taken die in de oorspronkelijke methode worden uitgevoerd.

Dit is de oorspronkelijke code:

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);
    }
}

Voer de volgende stappen uit om de ProcessData-methode te herstructureren:

Selecteer de Methode ProcessData.
Open inlinechat.
Voer een prompt in waarin GitHub Copilot wordt gevraagd om afzonderlijke methoden voor elke taak te maken en druk vervolgens op Enter.

Bijvoorbeeld: Ik wil de ProcessData-methode herstructureren. Ik wil een methode voor het opschonen van gegevens, een methode voor afdrukken en een methode voor gegevensverwerking.

Bekijk de voorgestelde code-update.

In dit voorbeeld stelt GitHub Copilot een geherstructureerde versie van de oorspronkelijke methode voor waarmee de opschonings- en afdruktaken worden gescheiden in afzonderlijke methoden.

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);
    }
}

In dit voorbeeld verbetert het herstructureren van de oorspronkelijke code de modulariteit en maakt de code gemakkelijker te begrijpen.

Selecteer Accepteren of Sluiten om de voorgestelde code-update te accepteren of te negeren.

In dit voorbeeld ziet de voorgestelde code er goed uit, dus selecteert u Accepteren om de geherstructureerde code toe te passen op uw project.

Controleer net als bij alle GitHub Copilot suggesties of de herziene code zonder fouten wordt uitgevoerd en het juiste resultaat oplevert.
Test de geherstructureerde code om ervoor te zorgen dat deze zonder fouten wordt uitgevoerd en genereert het verwachte resultaat.

Samenvatting

met de functie Inline Chat van GitHub Copilot kunt u code rechtstreeks in de code-editor herstructureren. Inlinechat is handig als u wijzigingen in uw code wilt aanbrengen zonder over te schakelen naar de chatweergave. U kunt Inline Chat gebruiken om hulp te vragen bij specifieke coderingstaken, zoals het herstructureren van een functie of het verbeteren van de leesbaarheid van code. U kunt Inline Chat ook gebruiken om uw bestaande code te evalueren voordat u deze herstructureert.

Feedback

Is deze pagina nuttig?