Ein C#-Klassenbibliotheksprojekt erstellen - Einblicke aus Tim Coreys Lektion

Starten der Klassenbibliothek in Visual Studio

Tim beginnt damit zu sagen, dass sie eine Weile im Planungsmodus feststeckten, aber jetzt endlich bereit sind zu programmieren. Er öffnet Visual Studio und wählt "Neues Projekt erstellen", dann wählt er "Klassenbibliothek" aus. Tim nennt es TrackerLibrary und setzt den Lösungsnamen auf TournamentTracker.

Tims erste Aktion innerhalb der neuen Bibliothek ist das Löschen der standardmäßigen Class1.cs-Datei, da er keine standardmäßigen oder schlecht benannten Dateien in seinem Projekt haben möchte. Er sagt, dass Umbenennungen Probleme verursachen können, daher entfernt er sie vollständig, um später Probleme zu vermeiden.

Planung in Code umsetzen — Klassen hinzufügen

Tim erklärt, dass der eigentliche Vorteil der Planung darin besteht, dass Sie, wenn Sie bereit zum Codieren sind, nicht raten müssen, welche Daten Sie benötigen. Stattdessen übertragen Sie einfach das geplante Design in den tatsächlichen Code.

Er erwähnt, dass Sie zu diesem Zeitpunkt nicht darüber nachdenken, welche Daten benötigt werden, sondern eher Namen, Strukturen überprüfen und ob etwas fehlt. Tim sagt, das ist der Grund, warum Planung den Programmierprozess erheblich beschleunigt.

Erstellen des Team-Modells

Tim fügt die erste Klasse hinzu: TeamModel. Er erklärt, dass er es einfach Team nennen könnte, aber er zieht es vor, Model am Ende anzufügen, um es klar als Datenmodell zu kennzeichnen.

Er benutzt das prop-Snippet von Visual Studio, um schnell Eigenschaften zu generieren. Tim erstellt folgende Eigenschaften:

• Liste TeamMitglieder

• string TeamName

Tim erklärt auch einen wichtigen Punkt: Er möchte, dass TeamMembers automatisch initialisiert wird, damit die Liste nie null ist. Er zeigt zwei Ansätze:

1. Vor C# 6.0: Verwenden Sie einen Konstruktor, um die Liste zu initialisieren.

2. Seit C# 6.0: Direkt in der Eigenschaft initialisieren mit:

   public List<PersonModel> TeamMitglieder { get; set; } = neue List<PersonModel>();
   

Tim bevorzugt den modernen Ansatz, da er den Code vereinfacht.

Erstellen des Personenmodells

Als nächstes erstellt Tim PersonModel. Mit dem prop-Snippet fügt er schnell Eigenschaften hinzu:

• string Vorname

• string Nachname

• string E-Mail-Adresse

• string Handynummer

Tim zeigt, wie schnell sich Modelle erstellen lassen, wenn die Planung bereits abgeschlossen ist. Er erinnert uns auch daran, dass der Code jetzt direkt auf dem Planungsdokument basiert.

Erstellen des Turniermodells

Tim fügt das TournamentModel hinzu, das folgendes beinhaltet:

• string Turniername

• dezimal Teilnahmegebühr

• Liste AngemeldeteTeams

• Liste Preise

• Liste<Liste> Runden

Er hebt hervor, wie C# komplexe Listenstrukturen wie List<List> versteht und sogar den Typ autoausfüllt, wenn man "new" verwendet.

Preis-Modell hinzufügen

Tim fügt PrizeModel mit den folgenden Eigenschaften hinzu:

• int PlatzNummer

• string PlatzName

• dezimal PreisBetrag

• double PreisProzentsatz

Er merkt an, dass diese Werte momentan mit den Standardwerten belassen werden und später bei Bedarf angepasst werden können.

Erstellen von Matchup-Modellen

Tim fügt MatchupModel hinzu, einschließlich:

• Liste Einträge

• TeamModel Gewinner

• int MatchupRunde

Er stellt auch sicher, dass die Entries-Liste automatisch initialisiert wird, wie er es vorher gemacht hat.

Dann fügt Tim MatchupEntryModel hinzu, das enthält:

• TeamModel WettkampfTeam

• double Punktzahl

• MatchupModel ParentMatchup

Tim betont, dass diese Modelle die Grundlage der Klassenbibliothek vervollständigen.

Die Klassenbibliothek ist einfach, sobald sie geplant ist

Tim sagt, dass das Erstellen der Klassenbibliothek nach der Planung sehr einfach wird. Er betont, dass die Struktur der Bibliothek übersichtlich ist, weil die gesamte Designarbeit bereits abgeschlossen war.

Er erinnert uns daran, dass der Hauptvorteil der Planung darin besteht, dass das Programmieren schnell und sauber wird.

XML-Kommentare hinzufügen — Warum es wichtig ist

Tim weist darauf hin, dass der letzte Schritt sein sollte, den Code zu dokumentieren, insbesondere mit XML-Kommentaren. Er gibt zu, dass Kommentieren mühsam ist, warnt aber, dass Sie es wahrscheinlich später nicht mehr tun werden, wenn Sie es jetzt nicht tun.

Er zeigt, wie man XML-Kommentare erstellt, indem man drei Schrägstriche (///) über einer Eigenschaft eintippt. Tim demonstriert das Schreiben von Beschreibungen wie:

• "Stellt ein Team im Matchup dar"

• "Stellt die Punktzahl für dieses bestimmte Team dar"

• "Stellt das Matchup dar, aus dem dieses Team als Gewinner hervorgegangen ist"

Tim erklärt, dass XML-Kommentare nicht nur formatierte Kommentare sind — sie werden Teil der Dokumentation des Codes und helfen anderen Entwicklern, Ihre Klassen zu verstehen.

XML-Kommentare verbessern die Nutzbarkeit des Codes

Tim demonstriert, wie XML-Kommentare mit IntelliSense funktionieren. Er erstellt einen Konstruktor und fügt XML-Kommentare für den Parameter hinzu und zeigt, dass die Kommentare automatisch in IntelliSense erscheinen.

Er vergleicht dies mit der Beschreibung der integrierten Console.WriteLine() von Visual Studio, die aus Microsofts eigener XML-Dokumentation stammt. Tim erklärt, dass XML-Kommentare Ihnen ermöglichen, denselben Grad an Klarheit und Nutzbarkeit in Ihrer eigenen Klassenbibliothek bereitzustellen.

Abschließende Ermutigung

Tim ermutigt die Zuschauer, XML-Kommentare zu den restlichen Modellen hinzuzufügen, obwohl er den vollständigen Prozess aufgrund seiner sich wiederholenden Natur nicht zeigt.

Er schließt mit einer Vorschau auf die nächste Lektion: Formularerstellung. Tim merkt an, dass die in der Planung entworfenen Formulare einfache Skizzen waren und dass es jetzt an der Zeit ist, sie moderner und funktionaler zu machen.

Fazit — Tims Lektion auf den Punkt gebracht

Tim Coreys Lektion zeigt, dass das Erstellen einer C#-Klassenbibliothek darauf ankommt, die Planung in Code zu übersetzen. Die Schritte sind:

1. Erstellen Sie das Klassenbibliothek-Projekt

2. Fügen Sie Modelle basierend auf der Planung hinzu

3. Initialisieren Sie Listen, um Nullwerte zu vermeiden

4. Dokumentieren Sie den Code mit XML-Kommentaren

5. Bereiten Sie sich darauf vor, als nächstes Formulare zu erstellen

Durch das Befolgen von Tims Methode bauen Sie effizient und professionell eine saubere und gut strukturierte Klassenbibliothek auf, die den Rest Ihrer Anwendung unterstützt.