self-explanatory-code-commenting

Weniger, aber bessere Kommentare — Code soll sich selbst erklären

Für wen: Alle Sprachen

So nutzt du es

Inhalt als .github/copilot-instructions.md ins Repository legen (bzw. unter .github/instructions/ für mehrere Dateien). GitHub Copilot berücksichtigt die Anweisungen dann in Chat und Code-Vorschlägen für dieses Repository.

Im Detail

Diese Instruction bremst den Hang vieler KI-Assistenten, jede Zeile mit einem Kommentar zu erklären. Statt das ‘Was’ zu kommentieren, soll der Code selbst durch klare Namen und Struktur verständlich sein – Kommentare bleiben die Ausnahme für nicht-offensichtliches ‘Warum’ wie Workarounds oder überraschendes Verhalten. Der Nutzen: weniger Rauschen im Diff und weniger Kommentare, die nach einem Refactoring falsch werden. Für Teams, die saubere, wartbare Codebasen wollen und generierten Code nicht nachträglich von Kommentar-Ballast befreien möchten, eine einfache, sprach- und framework-unabhängige Regel.

Praxis-Tipp

Ergänze den Prompt zusätzlich mit ‘keine Kommentare zu offensichtlichem Code’, falls das Modell trotz Regel noch zu viel kommentiert.

Siehe auch

• code-review-generic
• performance-optimization

Lizenz & Quelle

• Lizenz: MIT
• Quelle: github.com/github/awesome-copilot

Lade …