\ Richtlinien für das V Framework Design

Transkript

1 \ Richtlinien für das V Framework Design Konventionen, Ausdrücke und Muster für wiederverwendbare.net-bibliotheken KrzysztofCwalina Brad Abrams ^ y ADDISON-WESLEY An imprint of Pearson Education München Boston San Francisco Harlow, England Don Mills, Ontario Sydney Mexico City Madrid Amsterdam

2 Inhaltsverzeichnis mmwmmmm>m*mmmmmmmmm=m Vorwort 13 Einleitung 15 1 Einführung Merkmale eines guten Framework-Designs Einfachheit Teurer Entwurfsprozess Kompromissbereitschaft Gründung auf Bewährtem Erweiterbarkeit Integration Konsistenz 29 2 Grundlagen des Framework-Designs Progressive Frameworks Grundlegende Prinzipien des Framework-Designs Szenarioorientiertes Design Niedrige Eingangsschwelle Selbst dokumentierende Objektmodelle Mehrschichtige Architektur Zusammenfassung 54 3 Benennungsrichtlinien Großschreibung Regeln für Bezeichner Akronyme Zusammengesetzte Wörter und allgemeine Begriffe Unterscheidung zwischen Groß-und Kleinschreibung 62

3 INHALTSYElZElCHilS 3.2 Allgemeine Benennungskonventionen Wortwahl Verwendung von Abkürzungen und Akronymen Sprachspezifische Namen vermeiden Neue Versionen vorhandener APIs benennen Benennung von Assemblies und DLLs Benennung von Namespaces Namespaces und Typnamenskonflikte Namen von Klassen, Strukturen und Schnittstellen Namen von generischen Typparametern Namen gebräuchlicher Typen Aufzählungen benennen Namen von Typmembern Methodennamen Eigenschaftsnamen Ereignisnamen Benennung von Feldnamen Benennung von Parametern Benennung von Ressourcenbezeichnern Zusammenfassung 86 Richtlinien für das Typdesign Typen und Namespaces Standardmäßige Unter-Namespaces Klasse oder Struktur? Klasse oder Schnittstelle? Design abstrakter Klassen Design statischer Klassen Design von Schnittstellen Design von Strukturen Design von Aufzählungen Flag-Aufzählungen entwerfen Aufzählungswerte hinzufügen Verschachtelte Typen Zusammenfassung 122 Memberdesign Allgemeine Designrichtlinien Memberüber ladung Explizite Implementierung von Schnittstellenmembern Eigenschaften und Methoden? 133

4 INHALTSVERZEICHNIS 5.2 Design von Eigenschaften Design indizierter Eigenschaften Ereignisse bei Eigenschaftsänderungen Konstruktordesign Richtlinien für Typkonstruktoren Ereignisdesign Design benutzerdefinierter Ereignishandler Felddesign Operatorüberladung Überladen des Operators == Konvertierungsoperatoren Parameterdesign Aufzählungs- oder boolesche Parameter? Validierung von Argumenten Parameterübergabe Member mit variabler Anzahl von Parametern Zeigerparameter Zusammenfassung 178 Erweiterbares Design Erweiterungsmechanismen Nicht versiegelte Klassen Geschützte (Protected) Member Ereignisse und Callbacks Virtuelle Member Abstraktionen (abstrakte Typen und Schnittstellen) Basisklassen Versiegeln Zusammenfassung 193 Exceptions (Ausnahmen) Auslösen von Exceptions Auswahl der richtigen Exception Design von Fehlermeldungen Ausnahmebehandlung Ausnahmen einhüllen Standardausnahmetypen verwenden Exception und SystemException ApplicationException InvalidOperationException ArgumentException, ArgumentNullException und ArgumentOutOfRangeException 215

5 8 *- INHALTSVERZEICHNIS NuUReferenceException, IndexOutOfRangeException und ArgumentOutOfRangeException StackOverflowException OutOfMemoryException ComException, SEHException und andere CLR-Exceptions ExecutionEngineException Benutzerdefinierte Exceptions entwerfen Exceptions und die Performanz Das Muster Tester-Ausführer (Tester-Doer-Pattern) Das Muster Try-Parse Zusammenfassung Verwendungsrichtlinien Arrays Attribute Collections Parameter von Collections Eigenschaften von Collections und Rückgabewerte Zwischen Arrays und Collections wählen Benutzerdefinierte Collections implementieren ICloneable IComparable<T> und IEquatable<T> IDisposable Object Object.Equals Object.GetHashCode Object.ToString Uri ,1 Implementierungsrichtlinien für System.Uri Verwendung von System.Xml Gleichheitsoperatoren Gleichheitsoperatoren bei Wertetypen Gleichheitsoperatoren bei Referenztypen Häufige Entwurfs-Patterns Aggregatkomponenten Komponentenorientiertes Design Aus einer Factory generierte Typen Richtlinien für Aggregatkomponenten Das Async-Pattern Grundlegendes Implementierungsbeispiel für das Async-Pattern 260

6 INHALTSVERZEICHNIS Das Dispose-Pattern Das grundlegende Dispose-Pattern Finalisierbare Typen Factories Das Pattem optionales Feature Das Pattern Schablonenmethode (Template-Pattern) Zeitüberschreitungen Ende gut, alles gut 283 A C#-Code-Konventionen 285 A.l Allgemeine Stilkonventionen 286 A.1.1 Klammern 286 A.1.2 Leerzeichen 287 A.l.3 Einrückungen 288 A.2 Namenskonventionen 289 A3 Kommentare 289 A.4 Dateiorganisation 290 B Designrichtlinien mit FxCop durchsetzen 293 B.l Was ist FxCop? 293 B.2 Die Entwicklung von FxCop 294 B.3 Funktionsweise 295 B.4 Durch FxCop abgedeckte Richtlinien 296 B.4.1 Benennungsrichtlinien 296 B.4.2 FxCop-Regeln für Typdesign-Richtlinien 305 B.4.3 FxCop-Regeln für das Memberdesign 308 B.4.4 FxCop-Regeln für Erweiterbarkeit 314 B.4.5 FxCop-Regeln für Exceptions 315 B.4.6 FxCop-Regeln für Verwendungsrichtlinien 317 B.4.7 FxCop-Regeln für Design-Patterns 322 C Beispielhafte API-Spezifikationen 323 Glossar 331 Empfohlene Literatur 335 Stichwortverzeichnis 337