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 bringt GitHub Copilot und vergleichbare Assistenten dazu, Kommentare sparsam und gezielt einzusetzen: keine Kommentare, die offensichtlichen oder redundanten Code wiederholen, sondern nur solche, die eine nicht triviale Design-Entscheidung oder einen Workaround erklären. Anhand von Vorher-Nachher-Beispielen in JavaScript, die sich aber auf jede Sprache übertragen lassen, zeigt sie, wie guter Code durch klare Namen selbst erklärend wird. Nützlich für Teams, die von KI generierten Code mit Kommentarflut satt haben, oder für Reviews, in denen überflüssige Kommentare auffallen. Wer ohnehin schon knapp kommentiert, findet hier wenig Neues.

Praxis-Tipp

Fügen Sie die Regel projektweit hinzu und lassen Sie den Assistenten vor jedem generierten Kommentar prüfen, ob der Code auch ohne ihn verständlich wäre.

Siehe auch

• code-review-generic

Lizenz & Quelle

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

Lade …