OOD Notation, Entwurf von Code Struktur

OOD Notation — mein Weg zum Entwurf von Code Struktur

Wer eine Software-Komponente zu implementieren hat, dem sollte zunächst eine abstrakte Spezifikation dieser Komponente vorliegen. C_WissDB_API (Business Layer) bzw. die umfassendere Spezifikation WissDB ist Beispiel dafür, wie solche Spezifikationen meiner Meinung nach am besten gestaltet werden.

Wie also würde man vorgehen, wenn man als Programmierer die Aufgabe bekäme, dieses WissDB_API zu implementieren als in Java oder C# geschriebene Anwendung der als C_WissDB_DL_API (Data Layer) spezifizierten Datenhaltungsschnittstelle?

Ganz sicher würde man

zuerst beide abstrakt spezifizierten APIs konkretisieren zu einem Interface im Sinne der Implementierungssprache (Java oder C#)
und würde sich dann überlegen, welche Hilfsklassen man implementieren sollte, die Abbildung des Business Layer APIs auf das Data Layer API zu bewerkstelligen.

Liebhaber von UML würden hierzu natürlich UML empfehlen. Ich selbst aber habe graphische Sprachen stets als viel zu umständlich empfunden und mir statt dessen eine textbasierte Notation definiert, die

extrem einfach,
sehr handlich
und automatisch nach Java oder C# umsetzbar

ist. Ich nenne sie OOD Notation (Object-oriented Design Notation) und betrachte sie als eine Art Design Stenografie. Sie ist Beispiel einer domänenspezifischen formalen Sprache für

Design of Classes and Interfaces based on Java or .NET

Wer meinen Ansatz verstehen möchte, betrachte als Beispiel

die Datei X.ood (in OOD notiertes Klassendesign aus einem Projekt BMF) und
den daraus generierten C# Code (zu finden in X.cs).

Der in diesem Fall genutzte Code-Generator war oodes.exe. Er unterstützt C# und die im Dokument Reference Card for OOD Notation spezifizierte Version meiner Design Stenografie.

Die Tatsache, dass

der Klassenentwurf in einer einzigen TXT Datei steht,
der generierte Code aber doppelt so umfangreich und zudem noch auf mehrere Dateien verteilt ist,

zeigt, welche Vereinfachung in etwa dieser Ansatz bewirkt.

Sicher ist zudem: Dieses Klassendesign in UML aufzuschreiben hätte mehr Arbeit erfordert und hätte mich zudem noch an allzu spezifisches Werkzeug gebunden. Den Generator oodes.exe für C# zu implementieren gelang in wenigen Stunden; projektspezifische Varianten zu erstellen ist einfach.

stw3872NOODAPI — Notation . OOD . API — News?

Mehr + B G E + S H A + More

Wissenswertes zu
Entwurf von Code Struktur, OOD Notation