Dieser Artikel erklärt, wie ein Roslyn-Analysator Ihnen helfen kann, Ihren Spielcode in Unity zu debuggen und die Qualität zu verbessern.
Ein Roslyn-Analysator ist ein Codeanalyse-Tool, das die APIs der Roslyn-Compiler-Plattform verwendet, um C#-Code in Echtzeit zu analysieren. Ein Analysator kann Verbesserungsvorschläge für den Code, Warnungen oder Fehler basierend auf einer Reihe vordefinierter Regeln bereitstellen. Es funktioniert als Plug-in für Microsoft Visual Studio und Microsoft Visual Studio Code und ergänzt die IntelliSense-Funktionen in beiden Code-Editoren.
Roslyn-Analysatoren bauen auf den Vorschlägen, Vervollständigungen und Informationen über verfügbare APIs auf, die von IntelliSense bereitgestellt werden, mit zusätzlichen Tools zur Analyse und Identifizierung potenzieller Probleme in Ihrem Code. Darüber hinaus erhalten Sie Vorschläge für mögliche Korrekturen unter Verwendung der APIs einer Roslyn-Compiler-Plattform.
Roslyn-Analysatoren sind nützlich, um Standards durchzusetzen und Sie zu warnen, wenn Sie eine Codekonvention verletzen. Darüber hinaus können sie oft helfen, diese Codefehler oder Stilverletzungen zu beheben.
Visual Studio wird mit vielen Standard-Analysatoren geliefert, die Teil des Open Source-Repos für Roslyn sind und eine gute Ressource darstellen, um mehr über das Debuggen mit dieser Methode zu lernen.
Hinweis: Der Großteil dieses Artikels gilt nur für Windows. Roslyn-Analysatoren sind auch für die Verwendung mit Visual Studio für macOS verfügbar, aber die Unterstützung für deren Inspektion ist im Vergleich zu dem, was für Windows verfügbar ist, eingeschränkt.
Das obige Bild ist aus einem Video, das eine typische Verwendung eines Roslyn-Analysators zeigt. In diesem Beispiel hat eine Analyse des Codes eine ungenutzte Variable entdeckt. Der Entwickler wird auf dieses Problem aufmerksam gemacht, da die Variable count mit einer grünen Welle unterstrichen ist. Ein Klick darauf zeigt das Problem und einen Link mit Optionen zur Behebung. Im Video entscheidet sich der Entwickler, die ungenutzte Variable basierend auf der Empfehlung zu entfernen.
Zusätzlich zu einer grünen Welle könnten Sie eine rote Welle oder graue Punkte sehen. Diese verschiedenen Symbole kennzeichnen das Sicherheitsniveau des Problems oder wie ernst das Problem für Ihren Code ist.
Wie die obige Tabelle zeigt, hat jeder Analyzer ein benutzerkonfigurierbares Schweregrad.
Es gibt mehrere Roslyn-Analyzer, aber Visual Studio wird auch mit einigen vorinstallierten geliefert. Sie können die Einstellungen dieser integrierten Analyzer an zwei Stellen anpassen. Für Ihre lokale Version von Visual Studio werden die Standardeinstellungen über Extras > Optionen > Text-Editor > C# > Code-Stil > Allgemein angepasst. Sie können den Schweregrad mit dem im obigen Bild gezeigten Dialogfeld ändern.
Das obige Bild zeigt eine einfache Code-Klasse. Das Ellipsensymbol (drei Punkte in einer Linie) unter den Buchstaben p und o in pos in Zeile 7 und der if Anweisung in Zeile 11 zeigt einen Vorschlag an. Die grüne Welle unter distance ist eine Warnung, und die rote Welle unter den beiden Instanzen von xPos in Zeile 11 ist ein Fehler. Warnungen und Fehler erscheinen auch im Fenster Fehlerliste.
Sie werden feststellen, dass das Bild, das die Einstellungen für integrierte Analyzer zeigt, zwischen nur Refactoring und dem Vorschlag für Codeblock-Präferenzen umschaltet: Bevorzugen Sie geschweifte Klammern. Nur Refactoring würde die Ellipse unter der if-Anweisung ausblenden.
Wenn die Einstellung für Bevorzugen Sie geschweifte Klammern ein Vorschlag ist und Sie über die Ellipse fahren, sehen Sie ein Panel, das einen potenziellen Fixes Link anzeigt. Ein Klick darauf zeigt ein weiteres Panel mit den verfügbaren Optionen. In diesem Fall ist nur eine Option verfügbar, um geschweifte Klammern zum Code hinzuzufügen. Das obige Bild zeigt diese Sequenz.
Wenn Sie den Code-Stil für ein bestimmtes Projekt sicherstellen möchten, können Sie eine .editorconfig Datei hinzufügen, die mit dem Projekt geliefert wird. Dies kann eine effiziente Möglichkeit sein, vereinbarte Code-Stilregeln in einem größeren Team von vielen Entwicklern durchzusetzen.
Eine .editconfig-Datei ermöglicht es Ihnen, die Einstellungen in Ihrer Version von Visual Studio über Extras > Optionen > Text-Editor > C# zu überschreiben. Sie können sogar mehrere .editorconfig-Dateien verschachteln, wenn nötig, indem Sie eine im Stammverzeichnis und eine in einem Unterordner platzieren. Die im Unterordner wird dann die im Stammverzeichnis überschreiben.
Die nächsten Abschnitte skizzieren, wie man eine .editorconfig-Datei hinzufügt.
Ändern Sie den Schweregrad eines enthaltenen Analysators in einem Code-Textfenster.
Klicken Sie mit der rechten Maustaste auf den Projektmappen-Explorer und wählen Sie Neues Element. Wählen Sie im nächsten Panel Installiert > C# > Allgemeine editorconfig-Datei (Standard).
Eine weitere Option besteht darin, die Generiere .editorconfig-Datei aus den Einstellungen im Extras > Optionen > Text-Editor > C# Panel auszuwählen (wie im Bild unter Konfigurieren integrierter Analysatoren zu sehen).
Jetzt, da Sie eine .editorconfig-Datei haben, zeigt Visual Studio (Windows-Version) eine bearbeitbare Ansicht der Textdatei im Hintergrund an. Änderungen an dieser Datei wirken sich auf C#-Skripte im Ordner aus, in dem die .editorconfig gespeichert ist, sowie auf alle Unterordner.
Sie können die Funktionalität erweitern, indem Sie die vorinstallierten Roslyn-Analyzer hinzufügen. Analyzer werden entweder als NuGet-Pakete oder als Visual Studio-Erweiterungen (VSIX-Dateien) installiert. Gehen Sie zu www.nuget.org für den Installationsprozess des NuGet-Pakets. Ein beliebter ist der StyleCop.Analyzers, der nach Stilproblemen in Ihrem Code sucht.
Installieren Sie das Paket in Visual Studio über die Paket-Manager-Konsole unter Tools > NuGet-Paket-Manager > Paket-Manager-Konsole. Die www.nuget.org Seite für jedes Analyzer-Paket zeigt Ihnen den Befehl, den Sie in die Paket-Manager-Konsole einfügen müssen. Es gibt sogar einen praktischen Button, um den Text in die Zwischenablage zu kopieren.
Die Analyzer-Assemblys werden installiert und erscheinen im Projektmappen-Explorer unter References > Analyzers.
Eine weitere Möglichkeit besteht darin, Analyzer zu installieren, die als VSIX-Erweiterungen bereitgestellt werden. Wählen Sie in Visual Studio Erweiterungen > Erweiterungen verwalten aus.
Wenn Sie den Namen der Erweiterung kennen, verwenden Sie das Suchfeld, um sie zu finden, oder suchen Sie einfach nach "Analyzer". Das obige Bild zeigt Comment Analyzer ausgewählt. Klicken Sie auf Herunterladen, um die Analyzer-Erweiterung zu installieren, wählen Sie OK, um das Dialogfeld zu schließen, und schließen Sie alle Instanzen von Visual Studio, um den VSIX-Installer zu starten.
Wählen Sie Ändern, um die Installation zu starten. Sobald die Installation abgeschlossen ist, wählen Sie Schließen und öffnen Sie Visual Studio erneut.
Wenn Sie überprüfen möchten, ob die Erweiterung installiert ist, wählen Sie Erweiterungen > Erweiterungen verwalten aus. Wählen Sie im Dialogfeld Erweiterungen verwalten die Kategorie Installiert auf der linken Seite aus und suchen Sie dann nach der Erweiterung nach Namen.
Dieser Artikel konzentrierte sich auf die integrierten Roslyn-Analyzer, die mit Visual Studio verfügbar sind, aber Sie können auch Ihre eigenen erstellen. Mit der .NET Compiler-Plattform erstellte Analyzer können die Qualität des Codes Ihres Teams erheblich verbessern.
Wenn Sie Erfahrung im Erstellen von Analyzern sammeln, werden Sie feststellen, wie sie Ihrem Team helfen, produktiver mit Codierungsproblemen wie Syntax, wiederholten Bearbeitungen, der Anleitung mit einer neuen Bibliothek und mehr zu werden.
Einige gute zusätzliche Ressourcen von Microsoft sind dieses Tutorial zur Erstellung Ihres eigenen C# Roslyn-Analyzers und dieses YouTube-Video über Roslyn-Analyzer.
Fehlerbehebung in Unity
Holen Sie sich weitere Tipps zur Fehlersuche in Ihrem Unity-Projekt aus diesen Artikeln:
Fortgeschrittene technische E-Books
Unity bietet eine Reihe von fortgeschrittenen Leitfäden, um professionellen Entwicklern zu helfen, den Spielcode zu optimieren. Erstellen Sie einen C#-Stil-Leitfaden: Schreiben Sie saubereren Code, der skalierbar ist und sammeln Sie Ratschläge von Branchenexperten, wie Sie einen Code-Stil-Leitfaden erstellen, um Ihrem Team zu helfen, eine saubere, lesbare und skalierbare Codebasis zu entwickeln.
Ein weiterer beliebter Leitfaden bei unseren Nutzern ist 70+ Tipps zur Steigerung der Produktivität mit Unity. Er ist vollgepackt mit zeitsparenden Tipps zur Verbesserung Ihres täglichen aggregierten Workflows mit Unity 2020 LTS – Tipps, die selbst erfahrene Entwickler möglicherweise übersehen haben.
Finden Sie alle fortgeschrittenen E-Books und Artikel von Unity im Unity-Best-Practices-Hub.
