Code programmatisch formatieren mit DotNet Format
[[academy-video-youtube({"vid": "lGvP9SZ98vM", "start_time": "0", "title": "Format Code Programmatically with .NET Format", "creator": "Gerald Versluis", "length": "9m 34s"})]]
In diesem Artikel führen wir Sie durch den Prozess der programmgesteuerten Formatierung Ihres C# .NET-Codes mit dem .NET-Format-Tool. Dieser Leitfaden basiert auf Gerald Versluis' Videotutorial zu "Formatieren Sie Ihren C# .NET-Code automatisch mit .NET Format", in dem er zeigt, wie Sie das Tool effektiv verwenden, um sicherzustellen, dass Ihr Code konsistent mit den Formatierungsstandards übereinstimmt. Ich werde Zeitstempel und ausführliche Erklärungen zu Geralds Vorgehen im Video bereitstellen, damit Sie den Ausführungen folgen und diese Techniken auf Ihre Projekte anwenden können.
Einführung in .NET-Format
Bei (0:36) führt Gerald .NET-Format als ein Tool ein, das darauf ausgelegt ist, C#-Code basierend auf den in einer .editorconfig-Datei definierten Regeln zu formatieren. Diese Datei ist entscheidend, um konsistente Codierungsstile in Ihrem Projekt zu erzwingen. Sie stellt sicher, dass der gesamte Code die gleichen Formatierungsrichtlinien einhält, die Folgendes beinhalten können:
- Einrückungsstil: Ob Tabulatoren oder Leerzeichen verwendet werden sollen.
- Abstandsregeln: Die Menge an Leerraum um Operatoren, geschweifte Klammern usw.
- Code-Struktur: Wie einzeilige und mehrzeilige Konstrukte formatiert werden.
Durch die Anwendung dieser Regeln hilft .NET-Format, einen einheitlichen Codebestand beizubehalten, was das Lesen und Verwalten erleichtert.
Verstehen der .editorconfig-Datei
Die Datei .editorconfig, die Gerald bei (0:48) erklärt, legt verschiedene Einstellungen für den Codierungsstil fest. Diese Datei ist sehr flexibel und ermöglicht es Ihnen, eine breite Palette von Formatierungsregeln zu definieren, einschließlich:
- Einrückungsvorgaben: Bestimmt, ob Tabulatoren oder Leerzeichen für die Einrückung verwendet werden und wie viele Leerzeichen verwendet werden.
- Abstandsrichtlinien: Steuert die Abstände um Codeelemente wie Operatoren, geschweifte Klammern und Schlüsselwörter.
- Andere Formatierungsregeln: Definiert zusätzliche Stilregeln, um die Konsistenz des Codes zu gewährleisten.
Die Datei .editorconfig dient als zentraler Punkt für die Konfiguration der Codeformatierung in verschiedenen Editoren und IDEs.
Überblick über das .NET-Format-Tool
Gerald erklärt, dass .NET-Format ein globales Tool für die .NET-Laufzeit bei (1:13) ist. Da es sich um ein globales Tool handelt, kann es einmal installiert und in verschiedenen .NET-Projekten auf Ihrem System verwendet werden. Dies ermöglicht eine konsistente Code-Formatierung, ohne dass für jedes Projekt separate Installationen oder Konfigurationen erforderlich sind.
Sie können das .NET-Format-Repository auf GitHub bei (1:26) aufrufen. Dieses Repository bietet den Quellcode, die Dokumentation und zusätzliche Informationen über das Tool, damit die Benutzer die Funktionen verstehen und mit den neuesten Versionen auf dem Laufenden bleiben können.
Grundlegende Verwendung von .NET-Format
Bei (2:09) demonstriert Gerald den grundlegenden Befehl zur Verwendung von .NET-Format:
dotnet format <options> <workspace>dotnet format <options> <workspace>Was ist ein Arbeitsbereich?
Im Kontext von .NET-Format bezieht sich der Begriff "Workspace" auf den Bereich des Codes, der formatiert wird. Dies kann Folgendes beinhalten:
- Eine Lösungsdatei: Die .sln-Datei, die mehrere Projekte umfasst.
- Eine Projektdatei: Eine einzelne .csproj-Datei, die bestimmte Codedateien enthält.
- Ordner: Ein Verzeichnis, das mehrere Codedateien enthält, einschließlich .cs und möglicherweise .vb-Dateien.
Die Flexibilität, verschiedene Arten von Arbeitsbereichen festzulegen, ermöglicht es Ihnen, die Formatierung auf verschiedenen Ebenen Ihres Projekts anzuwenden.
Funktionen und Optionen
Gerald hebt bei (2:27) mehrere wichtige Funktionen und Optionen von .NET-Format hervor:
- Automatische Korrektur: Das Tool kann Formatierungsprobleme automatisch korrigieren, basierend auf den Regeln, die in Ihrer .editorconfig-Datei definiert sind. Dies ist nützlich, um einen konsistenten Codestil für Ihr gesamtes Projekt zu erhalten, ohne dass Sie manuell eingreifen müssen.
- Nur prüfen: Wenn Sie es vorziehen, Formatierungsprobleme zu überprüfen, ohne Änderungen vorzunehmen, können Sie das Tool verwenden, um nur auf Probleme zu prüfen. Diese Funktion ist besonders nützlich für kontinuierliche Integrationspipelines (CI).
Erweiterte Optionen und Anpassungen
Gerald erforscht erweiterte Optionen und Anpassungsmöglichkeiten. Er erwähnt:
- Schweregrad: Hier können Sie angeben, welche Schweregrade von Problemen behoben werden sollen. Dies hilft dabei, bestimmte Arten von Formatierungsproblemen anzugehen.
- Dateien einschließen/ausschließen: Sie können steuern, welche Dateien von der Formatierung ein- oder ausgeschlossen werden. Dies ist nützlich, um sich auf bestimmte Teile Ihrer Codebasis zu konzentrieren.
- Nur mit Exit-Code prüfen: Mit der Option "Prüfen" können Sie überprüfen, ob es Formatierungsprobleme gibt, ohne Korrekturen vorzunehmen. Der Exit-Code gibt an, ob Probleme gefunden wurden.
- JSON-Bericht: Erzeugt einen detaillierten Bericht im JSON-Format, der Einblicke in den Formatierungsstatus Ihres Codes gibt.
- Verbosity: Legen Sie die Verbosity-Stufe fest, um den Umfang der erzeugten Ausgabe zu steuern.
- Tool-Version: Überprüfen Sie die Version von .NET-Format, um die Kompatibilität mit Ihrem Projekt sicherzustellen und mit neuen Funktionen auf dem Laufenden zu bleiben.
Installation of .NET Format Tool
Gerald beginnt mit der Erklärung des Installationsprozesses für das .NET-Format-Tool, das für die programmgesteuerte Formatierung von C#-Code unerlässlich ist. Er zeigt, wie man es mit dem folgenden Befehl als globales Werkzeug einrichtet:
dotnet tool install -g dotnet-formatdotnet tool install -g dotnet-formatDieser Befehl sorgt dafür, dass .NET-Format global verfügbar ist, sodass von jeder Befehlszeile oder jedem Terminal aus leicht darauf zugegriffen werden kann. Gerald unterstreicht die Notwendigkeit der .NET Core-Laufzeitumgebung, die installiert sein sollte, wenn Sie in letzter Zeit mit .NET gearbeitet haben.
Um zu bestätigen, dass die Installation erfolgreich war, startet Gerald bei (4:00):
dotnet format /?dotnet format /?Dieser Befehl zeigt die Liste der verfügbaren Optionen und Befehle an, wodurch bestätigt wird, dass .NET-Format ordnungsgemäß installiert und einsatzbereit ist.
Bei (4:11) weist Gerald darauf hin, dass einige Optionen, wie z. B. --dry-run, veraltet sind, und rät dazu, aktualisierte Verfahren für die Codeformatierung zu verwenden.
Korrekturen bei der Code-Formatierung anwenden
Prüfung von Formatierungsproblemen
Anhand der Xamarin Community Toolkit-Codebasis als praktisches Beispiel prüft Gerald zunächst, ob Formatierungsprobleme vorliegen, ohne Änderungen vorzunehmen. Er läuft:
dotnet format . -f --checkdotnet format . -f --checkum Dateien zu identifizieren, die formatiert werden müssen. Gerald erklärt bei (5:26), wie Sie den Arbeitsbereich mithilfe von --folder für Verzeichnisse oder .NET-Format sln für Lösungsdateien angeben können. Dieser Befehl listet Dateien mit Formatierungsproblemen auf.
Fehlerstufenprüfung
Jeder Prozess, der ausgeführt wird, hat einen Exit-Code, der den Status angibt. Gerald hat den folgenden Befehl ausgeführt, um die Fehlerquote zu überprüfen:
echo %errorlevel%echo %errorlevel%Gerald demonstriert, dass ein Exit-Code von 2 signalisiert, dass Formatierungsfehler vorliegen, die behoben werden müssen.
Anwenden und Überprüfen von Korrekturen
Gerald zeigt dann, wie man Formatierungskorrekturen vornimmt, indem er den Befehl noch einmal ausführt, allerdings ohne das --check-Flag:
dotnet format . -fdotnet format . -fDadurch werden die Codedateien automatisch anhand der in der Datei .editorconfig definierten Regeln formatiert. Gerald prüft den Exit-Code erneut mit dem gleichen Befehl wie oben, um sicherzustellen, dass er 0 ist, was bedeutet, dass alle Formatierungsprobleme behoben wurden.
Um die Änderungen zu überprüfen, verwendet er bei (8:00) ein grafisches Tool wie GitHub Desktop, um die aktualisierten Dateien zu überprüfen. Das Tool zeigt Verbesserungen wie korrigierte Leerzeichen, organisierte using-Anweisungen und andere Formatierungsanpassungen.
Formatierung in Ihren Arbeitsablauf integrieren
Gerald empfiehlt, das .NET-Format-Tool in Ihre Build-CI-Pipeline zu integrieren. Diese Praxis gewährleistet, dass die Codeformatierung konsistent angewendet wird und hilft, hohe Code-Qualitätsstandards beizubehalten. Durch die Automatisierung des Formatierungsprozesses können Sie manuelle Formatierungsaufgaben vermeiden und sicherstellen, dass der gesamte Code die festgelegten Stilregeln einhält.
Abschluss
Durch das Befolgen von Geralds detaillierter Anleitung können Sie das .NET-Format leicht in Ihren Entwicklungsprozess integrieren, um die Formatierung Ihres C# .NET-Codes zu automatisieren. Egal, ob Sie alleine oder im Team arbeiten, dieses Tool hilft Ihnen dabei, sicherzustellen, dass Ihr Code sauber, konsistent und leicht zu lesen ist. Schauen Sie sich unbedingt Geralds Video für eine praktische Demonstration und weitere Einblicke in das .NET-Format-Tool an. Besuchen Sie auch seinen YouTube-Kanal für weitere Einblicke in C#-Code.
Kostenlos loslegen
Kostenlos loslegen
Kostenlose Live-Demo buchen
