Ü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:

  • Fragemodus: Verwenden Sie die Chat-Ansicht im Fragemodus, um Ihren gesamten Arbeitsbereich zu analysieren und Fragen zu Programmierungsthemen, Technologiekonzepten und allgemeinen Programmierpraktiken zu stellen.

  • Inline-Chat: Starten Sie eine Inline-Chat-Sitzung direkt aus dem Editor, um Fragen zu bestimmten Codeabschnitten zu stellen.

  • 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 mithilfe von GitHub Copilot

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

  • Ask-Modus: Verwenden Sie den Frag-Agentenmodus, um Inline-Code-Dokumentation für eine Code-Datei, eine Klasse oder eine Methode vorzuschlagen. Überprüfen Sie die vorgeschlagene Inlinedokumentation in der Chatansicht. Fordern Sie Aktualisierungen nach Bedarf im Chatgespräch an. Sobald Sie mit der vorgeschlagenen Dokumentation zufrieden sind, können Sie die vorgeschlagene Dokumentation in die entsprechende Codedatei einfügen.

  • Planmodus: Verwenden Sie den Planmodus, um einen detaillierten Implementierungsplan für Ihre Dokumentationsaufgaben zu erstellen. Der Planmodus kann verwendet werden, um die Codebasis zu analysieren, Dokumentationsanforderungen zu identifizieren und einen schrittweisen Plan zu erstellen. Nachdem der Plan genehmigt wurde, können Sie ihn zur Ausführung an den Agentmodus übergeben.

  • Agentmodus: Verwenden Sie den Agentmodus, um die Inlinecodedokumentation für angegebene 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 mithilfe von GitHub Copilot

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

  • Chatansicht im Ask-Agent-Modus: Verwenden Sie den Ask-Agent, um die Codebasis zu analysieren und ein Verständnis der Codeprojekte, Dateien und Klassen zu erhalten. Der Ask-Agent kann verwendet werden, 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 Plan-Agent-Modus: Erstellen Sie einen detaillierten Implementierungsplan für die Projektdokumentation, und übergeben Sie dann den Agentmodus für die Ausführung.

  • Chatansicht im Agentmodus: Generieren einer Sammlung von Projektdokumentationsdateien: Erstellen/Aktualisieren der README.md, Erstellen/Aktualisieren des 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, zählt jede Eingabeaufforderung, die Sie eingeben, als premium-Anforderung, multipliziert mit dem Multiplikator des Modells. GitHub Copilot kann mehrere Folgemaßnahmen ergreifen, um Ihre Aufgabe abzuschließen, aber diese Folgemaßnahmen zählen nicht zur Nutzung Ihrer Premium-Anfragen. Nur die von Ihnen eingegebenen Eingabeaufforderungen werden abgerechnet. Die Gesamtzahl der verwendeten Premiumanfragen hängt davon ab, wie viele Aufforderungen Sie eingeben und welches Modell Sie auswählen. Der kostenlose Plan für GitHub Copilot erhält 50 Premium-Anforderungen pro Monat. Überprüfen Sie die Planbeschreibungen, um weitere Details zu Premium-Anforderungsgrenzwerten für jedes GitHub Copilot-Abonnement zu erhalten.

Zusammenfassung

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