Die erste Promptdatei

Erstelle deine erste Copilot-Promptdatei mit diesem einfachen Beispiel zur Erläuterung des Codes, das für jede Programmiersprache geeignet ist.

In diesem Artikel

Hinweis

Info zu Anpassungen

Du kannst GitHub Copilot mithilfe von zwei Dateitypen anpassen:

  • Benutzerdefinierte Anweisungen bieten einen fortlaufenden Leitfaden für das Verhalten von GitHub Copilot bei allen Interaktionen. Ein Einführungsbeispiel findest du unter Deine ersten benutzerdefinierten Anweisungen.
  • Promptdateien (Public Preview) definieren wiederverwendbare Prompts für bestimmte Aufgaben, die du bei Bedarf aufrufen kannst. Promptdateien sind nur in VS Code verfügbar.

Die erste Promptdatei

Beginne mit dieser einfachen Promptdatei, mit der du klare, gut dokumentierte Codeerklärungen schreiben kannst.

Prompt für die Erläuterung des Codes

Text
---
mode: 'agent'
description: 'Generate a clear code explanation with examples'
---

Explain the following code in a clear, beginner-friendly way:

Code to explain: ${input:code:Paste your code here}
Target audience: ${input:audience:Who is this explanation for? (e.g., beginners, intermediate developers, etc.)}

Please provide:

* A brief overview of what the code does
* A step-by-step breakdown of the main parts
* Explanation of any key concepts or terminology
* A simple example showing how it works
* Common use cases or when you might use this approach

Use clear, simple language and avoid unnecessary jargon.

Testen

  1. Speichere die obige Promptdatei in deinem .github/prompts-Ordner als explain-code.prompt.md.

  2. Zeige in Visual Studio Code die Copilot Chat-Ansicht an, und gib /explain-code ein.

    Copilot wechseln in den Agent-Modus, wenn dieser noch nicht ausgewählt ist. Daraufhin wirst du aufgefordert, Code und einen Zielgruppentyp einzugeben.

  3. Geben Sie Folgendes ein:

    Text
    The code is `function fibonacci(n) { return n <= 1 ? n : fibonacci(n-1) + fibonacci(n-2); }`. The audience is beginners.

Weitere Informationen