machichdigital

IDE-Tools · Foto: Homedust, CC BY 2.0

InstructionGitHub CopilotLizenz: MITfrei kopierbar

csharp

Zuletzt aktualisiert:

⬇ Als Datei laden

⧉ –× kopiert⬇ –× heruntergeladenBewertung:

Typ

Instruction

Lizenz

MIT

Anwendungsfeld

GitHub Copilot

.NET-Entwickler

Voraussetzungen

  • GitHub Copilot im C#-/.NET-Projekt
  • Vorhandene .editorconfig für konsistente Formatierung
  • Grundkenntnisse aktueller C#-Sprachfeatures

Einordnung

AufwandEinrichtung & Einarbeitung2/5 · eher geringNutzenErtrag im Alltag3/5 · mittelVoraussetzungenWas vorher da sein muss2/5 · eher gering1 = gering5 = hoch

Die Einbindung ist einfach, der Nutzen bleibt aber auf Stilkonsistenz in einer bestehenden C#-Codebasis begrenzt.

C#-Anwendungs-Guidelines

Für wen: .NET-Entwickler

Im Detail

Diese Instruction-Datei bringt GitHub Copilot dazu, konsequent aktuelle C#-14-Syntax vorzuschlagen statt veralteter Muster, und erzwingt Namenskonventionen wie PascalCase für öffentliche Member und ein „I“-Präfix für Interfaces. Zusätzlich verlangt sie Kommentare zu Design-Entscheidungen und sauberes Exception-Handling statt stiller Fehler. Der Nutzen liegt weniger in neuen Fähigkeiten als in Konsistenz: Teams mit eigener .editorconfig bekommen Vorschläge, die zum eigenen Codestil passen, statt generischen C#-Beispielcode. Für Einsteiger ist sie als Lernhilfe für aktuelle Sprachfeatures brauchbar, für Teams vor allem als Mittel gegen Stilbrüche in KI-generiertem Code.

Schritt für Schritt

  1. Prüfen, ob die eigene .editorconfig die Formatierungsvorgaben der Instruction abdeckt oder ergänzt werden muss.
  2. Bei neuem, von Copilot generiertem Code kontrollieren, ob PascalCase, das „I“-Präfix bei Interfaces und aktuelle C#14-Syntax angewandt werden.
  3. Stichprobenartig prüfen, ob XML-Doc-Kommentare bei öffentlichen APIs erzeugt werden.
  4. Bei Abweichungen, etwa altem Pattern-Matching-Stil, die Instruction nachschärfen.
  5. In älteren .NET-Projekten prüfen, ob die geforderte C#14-Syntax von der SDK-Version überhaupt unterstützt wird.

Beispiel aus der Praxis

Ein Entwickler lässt Copilot eine neue Schnittstelle für einen Nutzerdienst generieren; dank der Instruction schlägt Copilot automatisch „IUserService“ mit „I“-Präfix, PascalCase-Methodennamen und eine switch-Expression statt einer klassischen switch-Anweisung vor.

Praxis-Tipp

In die Repo-Wurzel als .github/copilot-instructions.md legen, dann greift sie automatisch bei jedem *.cs-Vorschlag – keine manuelle Aktivierung nötig.

Stolperfallen

Ohne passende .editorconfig im Projekt können Copilots Formatierungsvorschläge und die tatsächliche Codebasis auseinanderlaufen. In älteren .NET-Projekten kann das Verlangen nach C#14-Features zudem zu Code führen, den die vorhandene SDK-Version nicht kompiliert.

Siehe auch

Lizenz & Quelle

Häufige Fragen.

Muss mein Projekt bereits auf C# 14 laufen?

Die Instruction geht von der aktuellen Version aus; bei älteren Projekten sollten Sie diese Vorgabe anpassen.

Ersetzt sie eine eigene .editorconfig?

Nein, sie verweist ausdrücklich auf eine vorhandene .editorconfig und ergänzt sie um Namens- und Kommentarregeln.

Für wen ist sie am nützlichsten?

Für Teams mit eigenem Codestil, die Konsistenz in Copilot-Vorschlägen wollen, sowie für Einsteiger als Lernhilfe für aktuelle Sprachfeatures.

Inhalt ansehen (csharp.instructions.md)
Lade …

Erfahrungen & Kommentare.

Funktioniert der Instruction bei Ihnen? Tipps, Stolperfallen, Varianten — teilen Sie es mit der Community.

Lade Kommentare …

Ihre IP-Adresse wird zum Schutz vor Missbrauch gespeichert und nach 14 Tagen automatisch entfernt (Datenschutz).

Passt dazu.