Generer dokumentation af inline kode ved hjælp af GitHub Copilot

Korrekt dokumentation af din kode skaber en mere læsbar og vedligeholdbar kodebase, der er nemmere for andre udviklere at forstå og arbejde med.

GitHub Copilot Chat kan hjælpe dig med at dokumentere kode hurtigt, præcist og konsekvent.

Hver af følgende GitHub Copilot-funktioner kan bruges til at skabe inline kodedokumentation:

• Chatvisning: Brug chatvisningen i Ask, Agent eller Plan-tilstand.
• Indbygget chat: Brug en indbygget chatsession til at dokumentere specifik kode (klasser, metoder eller kodeblokke) uden at forlade editoren.

Generér dokumentation til indbygget kode ved hjælp af chatvisningen

Chatvisningen kan bruges til at generere indbygget kodedokumentation for et projekt, en kodefil, en klasse eller en metode. Du kan gennemse den foreslåede dokumentation og anmode om opdateringer efter behov, før du opdaterer kodefilen.

Hver af de tre tilstande i chatvisningen (Ask, Agent og Plan) kan bruges til at generere inline kodedokumentation. Omkostningerne ved at bruge agenttilstand er højere end de andre tilstande, hvilket kan være en overvejelse.

Generér indbygget kodedokumentation ved hjælp af chatvisningen i ask-tilstand

Ask-tilstanden kan bruges til at evaluere din kode og foreslå indbyggede kodedokumentationer til projekter, klasser eller metoder. Du kan gennemse den foreslåede indbyggede dokumentation og generere opdateringer efter behov, før du føjer dokumentation til kodefilen.

1. Åbn chatvisningen i ask-tilstand.

2. Føj kontekst til chatprompten. Tilføj f.eks. en Markdown-fil, der indeholder retningslinjer for dokumentation.

3. Angiv en prompt for at generere dokumentation til indbygget kode. Du kan f.eks. angive følgende prompt:

   Suggest inline code documentation for the ConsoleApp class.
   

4. Gennemse den foreslåede indbyggede kodedokumentation i chatvisningen.

   

5. Når du er tilfreds med den foreslåede dokumentation, kan du anvende den foreslåede dokumentation i den tilsvarende kodefil.

   Hold musemarkøren over den foreslåede dokumentation for at se knapperne Apply in Editor, Indsæt ved markøren og Kopier . Knappen Anvend i editor bruges til at anvende den foreslåede dokumentation på kodefilen.

   Du kan bruge knappen Indsæt ved markøren til at indsætte forslaget i editoren på den aktuelle cursorposition, eller kopier-knappen til at kopiere forslaget til udklipsholderen.

6. Når du har anvendt den foreslåede dokumentation på kodefilen, kan du navigere gennem opdateringerne for at acceptere, afvise eller ændre individuelle forslag.

   

   Brug pil op og ned på den nederste menulinje til at navigere gennem de foreslåede opdateringer.

   Når du navigerer gennem forslagene, kan du bevare eller fortryde individuelle forslag ved hjælp af pop op-menuen, der vises, når du holder markøren over forslaget.

   Du kan også redigere forslag manuelt efter behov.

7. For at acceptere eller afvise alle forslag, vælg knappen Behold eller Fortryd i den nederste menulinje.

   Du kan fortsætte med at opdatere dokumentationen efter behov i kodeeditoren.

Generer inline kodedokumentation ved hjælp af chatvisningen i Plan-tilstand

Chat-visningen i Plan-tilstand kan bruges til at lave en detaljeret plan for generering af inline-kodedokumentation på tværs af dit projekt. Plan-tilstanden analyserer din kodebase og producerer en trin-for-trin-plan, som kan overdrages til agent-tilstand til eksekvering.

1. Åbn chatvisningen i Plan-tilstand.

2. Indtast en prompt, der beskriver dine opgaver inden for inline-dokumentation.

   Du kan f.eks. angive følgende prompt:

   Create a plan for adding inline code documentation to the codebase. Document classes, properties, and methods. Identify all files that need documentation updates.
   

3. Gennemse implementeringsplanen.

   Efter et par øjeblikke viser Planagenten en plan i Chat-visningen. Planen giver et overordnet resumé og en gennemgang af trinene, inklusive eventuelle åbne spørgsmål til afklaring.

4. Når planen er færdig, vælg Start Implementering for at overdrage planen til agenttilstand, eller vælg Åben i Editor for at gemme planen som en Markdown-fil til senere brug.

   Når du vælger Start Implementation, skifter GitHub Copilot til agenttilstand og begynder at tilføje inline kodedokumentation baseret på den godkendte plan.

5. Gennemgå de opdaterede filer i editoren. Naviger gennem opdateringerne for at acceptere, afvise eller ændre individuelle forslag.

6. For at acceptere eller afvise alle forslag, vælg knappen Behold eller Fortryd i den nederste menulinje. Du kan også vælge knapperne Behold eller Fortryd i chatvisningen for at acceptere eller afvise alle forslag.

   Du kan fortsætte med at opdatere dokumentationen efter behov i kodeeditoren.

Generér indbygget kodedokumentation ved hjælp af chatvisningen i agenttilstand

Chatvisningen i agenttilstand kan bruges til at generere indbygget kodedokumentation for et projekt, en kodefil, en klasse eller en metode. Du kan gennemse den foreslåede indbyggede dokumentation og anmode om opdateringer efter behov, før du opdaterer kodefilen.

1. Åbn chatvisningen i agenttilstand.

2. Føj kontekst til chatprompten. For eksempel kan du bruge knappen Attach Context (papirclips-ikonet) til at tilføje kildekodemapper til chatten.

3. Angiv en prompt, der definerer dine dokumentationsopgaver.

   Du kan f.eks. angive følgende prompt:

   Create inline code documentation for all C# class files in the specified context. Document the class, properties, and methods. Do not add documentation to JSON, markdown, or other file types. Do not document UnitTest project files in the Test folder. Ensure that the solution builds without errors after the documentation is added.
   

4. Agenten viser statusmeddelelser i chatvisningen, når den fuldfører de anmodede opgaver.

   

   Agenten kan også anmode om mere kontekst eller bede om hjælp til at fuldføre de anmodede opgaver. Agenten kan f.eks. bede om tilladelse, før der køres en kommando i terminalen.

5. Vent på, at agenten fuldfører de ønskede dokumentationsopgaver, og gennemse derefter de opdaterede filer, som editoren har.

   

   Når agenttilstanden er færdig, vises en oversigt over de opgaver, den har fuldført. Du kan gennemse de opdaterede filer i editoren.

6. Naviger gennem opdateringerne for at acceptere, afvise eller ændre individuelle forslag.

   For at acceptere eller afvise alle forslag, vælg knappen Behold eller Fortryd i den nederste menulinje. Du kan også vælge knapperne Behold eller Fortryd i chatvisningen for at acceptere eller afvise alle forslag.

   Du kan fortsætte med at opdatere dokumentationen efter behov i kodeeditoren.

Generér indbygget kodedokumentation ved hjælp af indbygget chat

Funktionen indbygget chat kan bruges til at generere indbygget kodedokumentation til klasser, metoder eller komplekse kodeblokke. Prompten bruges til at angive kontekst eller til at angive specifikke instruktioner.

Indbygget chat foreslår dokumentation til indbygget kode direkte i kodeeditoren.

1. Åbn kodefilen i editoren.

2. Vælg den kode, du vil dokumentere.

3. Start en indbygget chatsession.

   Brug genvejen Ctrl+I eller vælg Åbn Inline Chat fra chatmenuen .

4. Angiv en prompt for at generere dokumentation til indbygget kode.

   Du kan f.eks. dokumentere en metode og anmode om specifikke oplysninger:

   Document the selected method. List currentState options
   

5. Gennemse den foreslåede indbyggede kodedokumentation i editoren.

6. Brug knappen Behold , accepter den foreslåede opdatering eller Fortryd for at afvise opdateringen.

Resumé

GitHub Copilot hjælper dig med hurtigt og præcist at generere inline kodedokumentation. Chatvisningen og de inline chatfunktioner giver forskellige niveauer af interaktion direkte i Visual Studio Code-miljøet.