Es wird empfohlen, einen Linter zu verwenden, um deinen Code auf mögliche Fehler, Stilverletzungen oder Abweichungen von Best Practices zu überprüfen. Linter können dich dabei unterstützen, Fehler frühzeitig zu erfassen, die Lesbarkeit deines Codes zu verbessern und sicherzustellen, dass dein Code konsistent ist und verwaltet werden kann.
Beispielszenario
Du hast einen Linter für deinen Code ausgeführt, und es wurden einige Probleme identifiziert, die behoben werden müssen. Anstatt diese manuell zu beheben, kannst du Copilot Chat bitten, diese für dich zu beheben.
Beispiele für Prompts
-
Wähle im Editor den gesamten Code aus, und gib Folgendes ein:
Fix the lint errors -
Du kannst bestimmte Codierungsrichtlinien für eine Sprache angeben, z. B. PEP8 für Python:
Use PEP8 to fix the lint errors -
Wenn du über eine lokale Datei verfügst, die deine Codierungskonventionen und -regeln definiert, kannst du die Datei in das Chatfenster ziehen, um sie als Anlage hinzuzufügen. Gib anschließend Folgendes ein:
Use the attached style guide to fix the lint errors -
Alternativ kannst du Copilot Chat bitten, lediglich einen bestimmten Lintfehlertyp zu beheben:
Make sure all functions use snake_case naming style
Beispielantwort
Copilot teilt dir mit, was geändert werden muss, und stellt dir anschließend den korrigierten Code bereit. Du solltest den vorgeschlagenen Code sorgfältig überprüfen, bevor du ihn verwenden. Der Code, den Copilot vorschlägt, kann nicht alle Probleme beheben, die dein Linter identifiziert. Deshalb solltest du den Linter jedes Mal erneut ausführen, wenn du den vorgeschlagenen Code verwendest.
Lintingprobleme, bei deren Behebung Copilot dich unterstützen kann, schließen Folgendes ein:
- Hinzufügen erforderlicher Importe,die fehlen
- Entfernen von Importen, die nicht im Code verwendet werden
- Aufteilen von Importanweisungen in separate Zeilen
- Verwenden von Methoden- und Funktionsnamen, die den Stilrichtlinien entsprechen
- Hinzufügen von Leerzeichen um Operatoren
- Sicherstellen eines konsistenten Einzugs
- Entfernen von nachfolgenden Leerzeichen
- Aufteilen mehrerer Anweisungen in separate Zeilen, die sich in einer einzelnen Zeile befinden
- Aufteilen langer Zeilen in mehrere Zeilen
- Entfernen nicht verwendeter Variablen
- Hinzufügen oder Entfernen leerer Zeilen für die Einhaltung von Stilrichtlinien
- Hinzufügen von Docstrings zu Funktionen, Klassen und Modulen
- Entfernen von Code, der nie ausgeführt wird
- Sicherstellen, dass alle Rückgabeanweisungen in einer Funktion entweder einen Wert oder nichts zurückgeben
- Reduzieren oder Beseitigen der Verwendung globaler Variablen
- Sicherstellen, dass Funktionen mit der richtigen Anzahl und dem richtigen Argumenttyp aufgerufen werden
- Sicherstellen, dass Kommentare richtig platziert werden und sinnvoll sind
- Ersetzen von Ausgabeanweisungen durch eine ordnungsgemäße Protokollierung