Generieren von Inlinecodedokumentation mit GitHub Copilot

  • 9 Minuten

Durch eine ordnungsgemäße Dokumentation des Codes wird eine besser les- und verwaltbare Codebasis erstellt, die andere Entwickler leichter verstehen und mit der sie einfacher arbeiten können.

GitHub Copilot Chat kann Ihnen helfen, Code schnell, präzise und konsistent zu dokumentieren.

Jede der folgenden GitHub Copilot-Features kann zum Erstellen der Inlinecodedokumentation verwendet werden:

  • Chatansicht: Die Chatansicht kann im Modus "Fragen", "Bearbeiten" und "Agent" verwendet werden.
  • Inlinechat: Verwenden Sie eine Inlinechatsitzung, um spezifischen Code (Klassen, Methoden oder Codeblöcke) zu dokumentieren, ohne den Editor verlassen zu müssen.
  • Intelligente Aktionen: Führen Sie die intelligente Aktion "Docs generieren" aus, um ausgewählten Code zu erläutern, ohne eine Eingabeaufforderung schreiben zu müssen.

Generieren Sie Inline-Codedokumentation mithilfe der Chatansicht

Die Chatansicht kann zum Generieren von Inlinecodedokumentationen für ein Projekt, eine Codedatei, eine Klasse oder eine Methode verwendet werden. Sie können die vorgeschlagene Dokumentation überprüfen und aktualisierungen nach Bedarf anfordern, bevor Sie die Codedatei aktualisieren.

Jeder der drei Modi der Chatansicht (Fragen, Bearbeiten und Agent) kann verwendet werden, um Inlinecodedokumentation zu generieren. Die Kosten für die Verwendung des Agent-Modus sind höher als die anderen Modi, die möglicherweise berücksichtigt werden können.

Generieren der Inlinecodedokumentation mithilfe der Chatansicht in Ask-Modus

Der Fragemodus kann verwendet werden, um Ihren Code auszuwerten und Inlinecodedokumentationen für Projekte, Klassen oder Methoden vorzuschlagen. Sie können die vorgeschlagene Inlinedokumentation überprüfen und nach Bedarf Updates generieren, bevor Sie der Codedatei Dokumentation hinzufügen.

  1. Öffnen Sie die Chatansicht im Fragemodus.

  2. Fügen Sie der Chataufforderung Kontext hinzu. Fügen Sie beispielsweise eine Markdowndatei hinzu, die Dokumentationsrichtlinien enthält.

  3. Geben Sie eine Aufforderung zum Generieren der Inlinecodedokumentation ein. Sie können beispielsweise die folgende Eingabeaufforderung eingeben:

    @workspace /doc Create inline code documentation for the ConsoleApp class.

  4. Überprüfen Sie die vorgeschlagene Inlinecodedokumentation in der Chatansicht.

    Screenshot der Chatansicht im Fragemodus, der Inline-Dokumentation vorschlägt.

  5. Sobald Sie mit der vorgeschlagenen Dokumentation zufrieden sind, können Sie die vorgeschlagene Dokumentation auf die entsprechende Codedatei anwenden.

    Zeigen Sie mit dem Mauszeiger auf die vorgeschlagene Dokumentation, um die Schaltflächen "Anwenden", "Einfügen" und " Kopieren " anzuzeigen. Die Schaltfläche "Anwenden " wird verwendet, um die vorgeschlagene Dokumentation auf die Codedatei anzuwenden.

    Sie können die Schaltfläche "Einfügen " verwenden, um den Vorschlag an der aktuellen Cursorposition in den Editor einzufügen, oder die Schaltfläche " Kopieren ", um den Vorschlag in die Zwischenablage zu kopieren.

  6. Nachdem Sie die vorgeschlagene Dokumentation auf Ihre Codedatei angewendet haben, können Sie durch die Aktualisierungen navigieren, um einzelne Vorschläge anzunehmen, abzulehnen oder zu ändern.

    Screenshot, der die Inlinedokumentation zeigt, die im Fragemodus auf den Editor angewendet wird.

    Verwenden Sie die Pfeile nach oben und unten auf der unteren Menüleiste, um durch die vorgeschlagenen Updates zu navigieren.

    Während Sie durch die Vorschläge navigieren, können Sie einzelne Vorschläge beibehalten oder rückgängig machen, indem Sie das Popupmenü verwenden, das angezeigt wird, wenn Sie mit der Maus auf den Vorschlag zeigen.

    Sie können Vorschläge auch bei Bedarf manuell ändern.

  7. Wenn Sie alle Vorschläge annehmen oder ablehnen möchten, wählen Sie die Schaltfläche Beibehalten oder Rückgängig auf der unteren Menüleiste aus.

    Sie können die Dokumentation weiterhin nach Bedarf im Code-Editor aktualisieren.

** Generieren Sie die Inline-Code-Dokumentation mittels der Chatansicht im Bearbeitungsmodus.

Die Chatansicht im Bearbeitungsmodus kann verwendet werden, um Inlinecodedokumentation für Codedatei, Klasse oder Methode zu generieren. Sie können die vorgeschlagene Inlinedokumentation überprüfen und aktualisierungen nach Bedarf anfordern, bevor Sie die Codedatei aktualisieren.

  1. Öffnen Sie die Chatansicht im Fragemodus.

  2. Fügen Sie der Chataufforderung Kontext hinzu. Wählen Sie beispielsweise die Schaltfläche "Kontext hinzufügen" und dann "Editoren öffnen" aus, um dem Chat die geöffneten Editor-Registerkarten hinzuzufügen.

  3. Geben Sie eine Aufforderung zum Generieren der Inlinecodedokumentation ein.

    Sie können beispielsweise die folgende Eingabeaufforderung eingeben:

    Create inline code documentation for the ConsoleApp class. Document the class, its properties, and methods.

    Der Bearbeitungsmodus unterstützt nicht den @workspace Chatteilnehmer oder den /doc Slash-Befehl, daher müssen Sie eine detaillierte Eingabeaufforderung bereitstellen.

  4. Überprüfen Sie die vorgeschlagene Inlinecodedokumentation im Editor.

    Screenshot der Chatansicht im bearbeitenden Modus, wobei Inlinedokumentation vorgeschlagen wird.

  5. Navigieren Sie durch die Aktualisierungen, um einzelne Vorschläge anzunehmen, abzulehnen oder zu ändern.

  6. Wenn Sie alle Vorschläge annehmen oder ablehnen möchten, wählen Sie die Schaltfläche Beibehalten oder Rückgängig auf der unteren Menüleiste aus. Sie können in der Chatansicht auch die Schaltflächen Beibehalten oder Rückgängig auswählen, um alle Vorschläge anzunehmen oder abzulehnen.

    Sie können die Dokumentation weiterhin nach Bedarf im Code-Editor aktualisieren.

Inline-Codedokumentation mithilfe der Chatansicht im Agentenmodus generieren

Die Chatansicht im Agentmodus kann verwendet werden, um Inlinecodedokumentation für ein Projekt, eine Codedatei, eine Klasse oder eine Methode zu generieren. Sie können die vorgeschlagene Inlinedokumentation überprüfen und aktualisierungen nach Bedarf anfordern, bevor Sie die Codedatei aktualisieren.

  1. Öffnen Sie die Chatansicht im Agentmodus.

  2. Fügen Sie der Chataufforderung Kontext hinzu. Verwenden Sie beispielsweise die Schaltfläche " Kontext hinzufügen ", um dem Chat Quellcodeordner hinzuzufügen.

  3. Geben Sie eine Eingabeaufforderung ein, die Ihre Dokumentationsaufgaben definiert.

    Sie können beispielsweise die folgende Eingabeaufforderung eingeben:

    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.

    Der Agentmodus unterstützt nicht den @workspace Chatteilnehmer oder den /doc Schrägstrichbefehl, daher müssen Sie eine detaillierte Eingabeaufforderung angeben.

  4. Der Agent zeigt Statusmeldungen in der Chatansicht an, während die angeforderten Aufgaben abgeschlossen sind.

    Screenshot der Chatansicht im Agentmodus mit Statusmeldungen.

    Der Agent kann auch mehr Kontext anfordern oder um Unterstützung bitten, die angeforderten Aufgaben auszuführen. Beispielsweise kann der Agent vor dem Ausführen eines Befehls im Terminal um Erlaubnis bitten.

  5. Warten Sie, bis der Agent die angeforderten Dokumentationsaufgaben abgeschlossen hat, und überprüfen Sie dann die vom Editor aktualisierten Dateien.

    Screenshot der Chatansicht im Agentmodus nach Abschluss von Aufgaben.

    Wenn der Agentmodus abgeschlossen ist, wird eine Zusammenfassung der abgeschlossenen Aufgaben angezeigt. Sie können die aktualisierten Dateien im Editor überprüfen.

  6. Navigieren Sie durch die Aktualisierungen, um einzelne Vorschläge anzunehmen, abzulehnen oder zu ändern.

    Wenn Sie alle Vorschläge annehmen oder ablehnen möchten, wählen Sie die Schaltfläche Beibehalten oder Rückgängig auf der unteren Menüleiste aus. Sie können in der Chatansicht auch die Schaltflächen Beibehalten oder Rückgängig auswählen, um alle Vorschläge anzunehmen oder abzulehnen.

    Sie können die Dokumentation weiterhin nach Bedarf im Code-Editor aktualisieren.

Generieren der Inlinecodedokumentation mithilfe der intelligenten Aktion "Docs generieren"

Die intelligente Aktion "Docs generieren" kann zum Generieren von Inlinecodedokumentationen für Klassen, Methoden oder komplexe Codeblöcke verwendet werden. Es ist eine schnelle Möglichkeit, Dokumentationen zu generieren, ohne eine Eingabeaufforderung schreiben zu müssen. Die intelligente Aktion "Dokumente generieren" ist im Kontextmenü verfügbar, wenn Sie im Editor mit der rechten Maustaste auf den ausgewählten Code klicken.

Die intelligente Aktion Inline-Code-Dokumentation generieren schlägt direkte Dokumentation im Code-Editor vor.

  1. Öffnen Sie die Codedatei im Editor.

  2. Wählen Sie den Code aus, den Sie dokumentieren möchten.

  3. Klicken Sie mit der rechten Maustaste auf den ausgewählten Code, wählen Sie "Copilot" aus, und wählen Sie dann die intelligente Aktion " Docs generieren " aus.

    Screenshot der intelligenten Aktion

  4. Überprüfen Sie die vorgeschlagene Inlinecodedokumentation im Editor.

    Screenshot der Codedokumentation, die von der intelligenten Aktion

  5. Verwenden Sie die Schaltfläche " Annehmen ", um die vorgeschlagene Aktualisierung anzunehmen oder schließen, um die Aktualisierung abzulehnen.

    Sie können auch die Schaltfläche " Erneut ausführen " verwenden, um die Eingabeaufforderung mit oder ohne Updates erneut ausführen zu können.

Generieren von Dokumentation für Inline-Code mithilfe von Inline-Chat

Die Inlinechatfunktion kann zum Generieren von Inlinecodedokumentationen für Klassen, Methoden oder komplexe Codeblöcke verwendet werden. Die Eingabeaufforderung wird verwendet, um den Kontext anzugeben oder bestimmte Anweisungen bereitzustellen. Sie können auch den /doc Schrägstrichbefehl ohne Texteingabeaufforderung verwenden, wenn Sie möchten.

Inline-Chat empfiehlt Inline-Code-Dokumentation direkt im Code-Editor.

  1. Öffnen Sie die Codedatei im Editor.

  2. Wählen Sie den Code aus, den Sie dokumentieren möchten.

  3. Starten Sie eine Inlinechatsitzung.

    Verwenden Sie die Tastenkombination STRG+I, oder wählen Sie im Menü "Chat" denEditor-Inlinechat aus.

  4. Geben Sie eine Aufforderung zum Generieren der Inlinecodedokumentation ein.

    Sie können z. B. eine Methode dokumentieren und bestimmte Details anfordern:

    Document the selected method. List currentState options

  5. Überprüfen Sie die vorgeschlagene Inlinecodedokumentation im Editor.

    Screenshot einer Chat-Sitzung, die Dokumentation vorschlägt.

  6. Verwenden Sie die Schaltfläche " Annehmen ", um die vorgeschlagene Aktualisierung anzunehmen oder schließen, um die Aktualisierung abzulehnen.

    Sie können auch die Schaltfläche " Erneut ausführen " verwenden, um die Eingabeaufforderung mit oder ohne Updates erneut ausführen zu können.

Zusammenfassung

GitHub Copilot hilft Ihnen beim schnellen und präzisen Generieren von Inlinecodedokumentationen. Die Funktionen "Chat", "Inlinechat" und "Intelligente Aktionen" bieten verschiedene Interaktionsebenen direkt in der Visual Studio Code-Umgebung.