Formularentwicklung: Programmierrichtlinien & Namenskonventionen
Programmierrichtlinien und besonders Namenskonventionen gehören zur heutigen Anwendungs- und Systementwicklung wie Do-Schleifen und Semikolons. Programmierrichtlinien sind vereinbarte Regeln, die bei der Erstellung von Quellcode eingehalten werden können, um die Qualität der Software langfristig zu erhöhen.
Unter einer Namenskonvention wird die freiwillige Vereinbarung zwischen Entwicklern verstanden, wie Variablen, Konstanten und Objekte benannt werden sollen. Diese Richtlinien und Konventionen beziehen sich aber nicht ausschließlich auf die Programmierung. Auch bei der Entwicklung von Formularen können diese Muster verwendet werden, um die Lesbarkeit und Verständlichkeit zu erhöhen. In diesem Blogbeitrag werden ausgewählte Entwicklungsrichtlinien und Namenskonventionen für die Formularentwicklung vorgestellt, die sich in den letzten Jahren in unseren Projekten bewährt haben. Zu Beginn wird der Mehrwert von Namenskonventionen bei der Formularentwicklung erläutert.
Danach wird auf die Benennung von Formularen, Grafiken und Druckprogrammen eingegangen. Ferner werden ausgewählte Aspekte wie bspw. Die Handhabung von mehrsprachigen Formularen angesprochen. Im Abschluss wird der Inhalt kurz zusammengefasst.
Sehen die Namen Ihrer Entwicklungsobjekte vielleicht in etwa so aus?
Was bringen mir Namenskonventionen?
Namenskonventionen sind als spezielle Ausprägung von Programmierrichtlinien anzusehen. Der Mehrwert von Namenskonventionen lässt sich allgemein unter dem Begriff Übersichtlichkeit zusammenfassen.Zum Einen helfen Namenskonventionen während der Entwicklung selbst, eine gewisse Lesbarkeit zu gewährleisten, wodurch der Entwickler wesentlich produktiver arbeiten kann. Das Ergebnis ist eine Qualitätssteigerung und womöglich eine Zeitersparnis, weil der Entwickler z. B. nicht erst überlegen muss, wofür ein Objekt eigentlich gedacht ist, da er dieses bereits im Vorfeld adäquat bezeichnet hat.
Zum Anderen hilft eine durchgängige und durchdachte Namenkonvention bei der Einarbeitung in fremde Formularentwicklungen, weil so Verständnisfragen zum Formular oder zum dazugehörigen Druckprogramm gar nicht erst aufkommen. Insofern trägt die Verwendung von Namenskonventionen zusätzlich der Wartbarkeit und Erweiterbarkeit von Formularentwicklungen bei und ein möglicher Technologiewechsel wird erleichtert.
Eine durchdachte Namenskonvention gewährleistet Beständigkeit
Namenskonventionen
Formularnamen sollten wie gewohnt mit dem Kundennamensraum gefolgt vom Modul- oder Projektnamen beginnen. Nach einem Unterstrich wird der eigentliche Formularname ausgeschrieben.
Somit ergibt sich folgender schematischer Formularname: Z<MODUL>_<FORMULARNAME>. Beim dazugehörigen Druckprogramm wird dieser Name wiederverwendet und um _PRINT erweitert. Formulargrafiken beginnen mit dem Kundennamensraum gefolgt von _LOGO. Dieses Schema wird situationsbedingt um den Namen der jeweiligen Organisationseinheit erweitert, wobei erneut der Unterstrich als Trennzeichen fungiert.
Insgesamt ergibt sich folgende Bezeichnung: Z_LOGO_<ORGEINHEIT>. Formulargrafiken sollten allerdings niemals direkt in das Formular eingebettet werden. Hier bietet sich die Schnittstelle über den Business Document Service (BDS) an.
Best-Practice für mehrsprachige Formulare
Formulare werden in der Regel zunächst in der angeforderten Sprache abgelegt und dann um weitere Sprachen erweitert, wenn diese gewünscht sind. In SAPscript können Standard-Textsymbole verwendet werden. Der SAPscript-Prozessor liest den sprachabhängigen Inhalt zur Laufzeit über die TTDTG-Tabelle und schreibt ihn in das Formular.
Bei Texten im SAP SmartForms und Adobe Interactive Forms wird zwischen kurzen und langen Texten unterschieden. Kurze Texte können im Formular eingebunden und über die Transaktion SE63 übersetzt werden. Längere Texte können über die Transaktion SO10 als Standardtext angelegt und übersetzt werden.
Diese Texte sollten mit dem Kundennamensraum gefolgt von der Organisationseinheit beginnen. Nach einem Unterstrich als Trennzeichen wird der Textname ergänzt. Somit ergibt sich folgenden Schema: Z<ORGEINHEIT>_<TEXTNAME>.
Erstellen eines Standardtexts gemäß der Namenskonvention in der Transaktion SO10
Zusammenfassung
In diesem Beitrag wurden ausgewählte Programmierrichtlinien und Namenskonventionen für die Formularentwicklung vorgestellt.
Der wesentliche Mehrwert dieser Richtlinien ist die Übersichtlichkeit, wodurch die Qualität der Entwicklung selbst steigt und sich neue Entwickler schneller einarbeiten können, weil die Namen der Objekte stringent sind. Als Bezeichnung von Formularen, Formulargrafiken und Druckprogrammen haben sich wiederkehrende Muster durchgesetzt.
Bei diesen Mustern sollte darauf geachtet werden, dass eine Zugehörigkeit zu Modulen, Projekten oder Organisationseinheiten dargestellt wird. Als Best-Practice für mehrsprachige Formularentwicklung hat sich die Auslagerung von Texten bewährt, um diese dort zentral zu übersetzen und zu organisieren.
Diese sowie weitere Richtlinien und Konventionen wie bspw. die Kennzeichnung von Testdrucken und die Verwendung von Skriptsprachen bei Adobe Interactive Forms finden Sie im bereitgestellten Download.
