eBiss 3

Hilfe & Dokumentation

Benutzer-Werkzeuge

Webseiten-Werkzeuge


Seitenleiste

Themen

howtos:namenskonventionen:schnittstellen

Namenskonventionen für Schnittstellen-Typen

Typbibliothek benennen

Für die Benennung der DLL Datei werden i.d.R. die Bezeichner des zu bedienenden Hostsystems oder der Schnittstelle allgemein verwendet.
Idealerweise so, dass die Bezeichnung eindeutig identifizierbar und auch sprechend bleibt. Die Bezeichnung des Namensraums sollte idealerweise identisch gehalten werden.
Damit die Quelle/ Herkunft der Schnittstelle bekannt ist, sollte bestenfalls immer ein Firmenname vorangestellt sein.


Systemverwaltete Typen benennen

Typen werden idealerweise mit einem sprechenden Typ-Namen versehen. Da der Namensraum bereits in der Typbibliothek definiert ist, ergibt sich dann der zusammengesetzte Typ-Name wie folgt:

firma.namespace.typename

Beispiel: Pranke.SAP.Invoic01 oder optional auch mit einem untergeordneten Namensraum um zum Beispiel Subtypen zu definieren.

firma.namespace.subnamespace.typename

Beispiel: Pranke.FXL.Invrpt.Stock und Pranke.FXL.Invrpt.Movement

Hinweis: Benutze die Type-Beschreibung um Hinweise auf die Nachrichtenrichtung1) zu geben.

1)
Ein- oder ausgehend
howtos/namenskonventionen/schnittstellen.txt · Zuletzt geändert: 2024/02/20 08:15 von 127.0.0.1