Programmierer aus Leidenschaft - Teil 3: Was ich unter gutem Bibliotheksdesign verstehe

Um gute Programme zu schreiben bedarf es auch gut gemachter Bibliotheken. Was ich unter einer gut gemachten Bibliothek verstehe, will ich in diesem Artikel erläutern.

Eine gut gemachte Bibliothek muss folgende Kriterien erfüllen:

• Die Namen aller Klassen und Funktionen (Prozeduren) in der Bibliothek müssen einer einheitlichen Namenskonvention entsprechen.
• Alle Klassen und Funktionen müssen ausführlich dokumentiert und gegebenenfalls mit Code-Beispielen ausgestattet sein. Die Dokumentation muss im HTML-Format vorliegen.
• Die Bibliothek sollte gut getestet sein, zum Beispiel mittels Unit-Tests.
• Die API sollte möglichst langlebig und stabil sein. Jede Änderung eines Funktions-/Klassennamen zieht u.U. aufwendige Änderungen am Code nach sich, was wiederum in erhöhte Fehleranfälligkeit mündet und damit den Testaufwand erhöht.

Beispiele für gute Bibliotheken: Qt (C++), .NET (C#), Ogre (C++), boost (C++)