Beheben von Lintfehlern

Copilot-Chat kann Lösungen für Probleme vorschlagen, die von einem Code-Linter erkannt wurden.

In diesem Artikel

Es ist eine gute Praxis, einen Linter zu verwenden, um deinen Code auf mögliche Fehler, Stilverletzungen oder Abweichungen von den besten Praktiken 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, dabei wurden einige Probleme festgestellt, die behoben werden müssen. Anstatt diese manuell zu beheben, können Sie Copilot-Chat bitten, sie für Sie zu beheben.

Beispiel-Prompts

  • Wähle im Editor den gesamten Code aus, und gib Folgendes ein:

    Copilot prompt
    Fix the lint errors

  • Du kannst bestimmte Codierungsrichtlinien für eine Sprache angeben, z. B. PEP8 für Python:

    Copilot prompt
    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:

    Copilot prompt
    Use the attached style guide to fix the lint errors

  • Alternativ können Sie Copilot-Chat bitten, nur einen bestimmten Typ von Lint-Fehler zu beheben:

    Copilot prompt
    Make sure all functions use snake_case naming style

Beispielantwort

Copilot teilt Ihnen mit, was geändert werden muss, und gibt Ihnen dann den korrigierten Code. Du solltest den vorgeschlagenen Code sorgfältig überprüfen, bevor du ihn verwenden. Der Code, den Copilot vorschlägt, behebt möglicherweise nicht alle von Ihrem Linter erkannten Probleme. Daher sollten Sie den Linter immer erneut ausführen, wenn Sie sich dafür entscheiden, den vorgeschlagenen Code zu verwenden.

Zu den Linting-Problemen, bei deren Behebung Copilot helfen kann, gehören:

  • Hinzufügen der notwendigen 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
  • Mehrere Anweisungen, die sich auf einer einzigen Zeile befinden, in separate Zeilen aufteilen.
  • 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 Printausgaben durch ordnungsgemäße Protokollierung

Weiterführende Lektüre