Überprüfen sie die Features "erklären" und "Dokument" von GitHub Copilot

  • 5 Minuten

GitHub Copilot erleichtert Entwicklern die Arbeit mit komplexem oder unbekanntem Code. In Visual Studio Code haben Entwickler direkten Zugriff auf GitHub Copilot-Features, die Code analysieren, erläutern oder dokumentieren.

Analysieren und Erläutern von Code mithilfe von GitHub Copilot

Die folgenden GitHub Copilot-Features können verwendet werden, um Code zu analysieren und zu erläutern:

  • Ask mode: Use the Chat view in ask mode to analyze your entire workspace and ask questions about coding topics, technology concepts, and general programming practices.

  • Inlinechat: Starten Sie eine Inlinechatsitzung direkt vom Editor, um bestimmte Codeabschnitte zu fragen.

  • Intelligente Aktionen: Führen Sie die Intelligente Erklären-Aktion aus, um ausgewählten Code zu erläutern, ohne eine Eingabeaufforderung schreiben zu müssen.

  • Schnellchat: Stellen Sie eine kurze Frage, und kehren Sie zurück zu dem, was Sie tun.

Generieren von Inlinecodedokumentation mit GitHub Copilot

Die folgenden GitHub Copilot-Features können verwendet werden, um Inlinecodedokumentation zu generieren:

  • Fragemodus: Verwenden Sie den Ask-Modus, um eine Inlinecodedokumentation für eine Codedatei, Klasse oder Methode vorzuschlagen. Überprüfen Sie die vorgeschlagene Inlinedokumentation in der Chatansicht. Fordern Sie aktualisierungen nach Bedarf in der Chatunterhaltung an. Sobald Sie mit der vorgeschlagenen Dokumentation zufrieden sind, können Sie die vorgeschlagene Dokumentation in die entsprechende Codedatei einfügen.

  • Bearbeitungsmodus: Verwenden Sie den Bearbeitungsmodus, um die Inlinecodedokumentation für eine Codedatei, Klasse oder Methode vorzuschlagen. Überprüfen Sie die vorgeschlagene Dokumentation im Editor, und navigieren Sie zwischen vorgeschlagenen Updates. Nehmen Sie einzelne Vorschläge an, oder lehnen Sie sie ab, oder ändern Sie vorschläge nach Bedarf.

  • Agentmodus: Verwenden Sie den Agentmodus, um die Inlinecodedokumentation für bestimmte Codeprojekte, Dateien, Klassen oder Methoden autonom zu generieren. Lassen Sie den Agent während oder nach dem Dokumentationsprozess andere Aufgaben ausführen. Akzeptieren oder ablehnen Sie die Updates, wenn der Agent die zugewiesenen Aufgaben abgeschlossen hat.

  • Inlinechat – Verwenden Sie eine Inlinechatsitzung, um direkt im Code-Editor zu arbeiten. Der Inlinechat ist nützlich, wenn Sie spezifischen Code (Klassen, Methoden oder Codeblöcke) dokumentieren möchten, ohne den Editor verlassen zu müssen. Sie können bestimmte Anweisungen in der Eingabeaufforderung angeben oder den /doc Schrägstrichbefehl ohne bestimmte Informationen verwenden, wenn Sie möchten. Updates werden im Code-Editor angezeigt und können akzeptiert oder abgelehnt werden. Sie können auch die Option zum erneuten Ausführen der Eingabeaufforderung mit oder ohne Updates auswählen.

  • Intelligente Docs-Aktion generieren: Verwenden Sie die intelligente Aktion "Docs generieren", um Inlinecodedokumentation für eine ausgewählte Klasse, Methode oder einen Codeblock zu generieren. Die intelligente Aktion "Dokumente generieren" ist nützlich, wenn Sie keine spezifischen Anforderungen haben, die eine Eingabeaufforderung erfordern. Updates werden im Code-Editor angezeigt und können akzeptiert oder abgelehnt werden. Sie können die intelligente Aktion auch erneut ausführen.

Generieren der Projektdokumentation mit GitHub Copilot

Die folgenden GitHub Copilot-Features können zum Generieren der Projektdokumentation verwendet werden:

  • Chatansicht im Fragemodus: Verwenden Sie den Ask-Modus, um die Codebasis zu analysieren und ein Verständnis der Codeprojekte, Dateien und Klassen zu erhalten. Verwenden Sie den Fragemodus, um eine Vorschau der vorgeschlagenen Projektdokumentation anzuzeigen. Überprüfen Sie Vorschläge, und fordern Sie Aktualisierungen oder andere Details nach Bedarf an. Fügen Sie die vorgeschlagene Dokumentation in eine Projektdokumentationsdatei (README.md) ein.

  • Chatansicht im Bearbeitungsmodus: Generieren einer Projektdokumentationsdatei (README.md).

  • Chatansicht im Agentmodus: Generieren einer Sammlung von Projektdokumentationsdateien: Erstellen/Aktualisieren der README.md, Erstellen/Aktualisieren der UsageExamples.md und Erstellen/Aktualisieren des ChangeLog.md. Fügen Sie Verknüpfungen zwischen den Dokumentationsdateien, referenzübergreifenden Klassen und Methoden ein, und sorgen Sie für Konsistenz über Dokumente hinweg.

Von Bedeutung

Wenn Sie die Chatansicht im Agentmodus verwenden, kann GitHub Copilot mehrere Premium-Anforderungen stellen, um eine einzelne Aufgabe abzuschließen. Premium-Anfragen können durch benutzerinitiierte Eingabeaufforderungen und Folgeaktionen verwendet werden, die Copilot in Ihrem Auftrag ausführt. Die Gesamtzahl der verwendeten Premium-Anforderungen hängt von der Komplexität der Aufgabe, der Anzahl der erforderlichen Schritte und dem ausgewählten Modell ab.

Zusammenfassung

GitHub Copilot hilft Ihnen, Ihren Code schnell und präzise zu analysieren und zu dokumentieren. Die Funktionen für Chats, Inlinechats, Schnellchats und intelligente Aktionen bieten verschiedene Interaktionsebenen direkt in der Visual Studio Code-Umgebung.