Erstellung eines Programmierhandbuchs

Alles rund um die Sprache ABAP®: Funktionsbausteine, Listen, ALV
4 Beiträge • Seite 1 von 1
4 Beiträge Seite 1 von 1

Erstellung eines Programmierhandbuchs

Beitrag von cosmo (Specialist / 175 / 0 / 0 ) »
Hallo zusammen,

in meiner Firma möchten wir ein Programmierhandbuch erstellen. Dort sollen Vorgehensweisen z.B. bei der Namensgebung von Variablen, Unterprogrammen etc. für alle Programmierer festgelegt werden. Ziel ist die Erhöhung der Codequalität.

Ein wichtiger Punkt ist auch die Nomenklatur bei Dictionary-Objekten, Paketen, FuBas, Klassen usw.

Wer hat so was schon mal gemacht und könnte vielleicht eine Vorlage zur Verfügung stellen. Oder gibt es von SAP hier irgendwas?

Danke und Gruß an alle
Jörg Krause, Anwendungsentwickler und SAP-Betreuer MM/PP

gesponsert
Stellenangebote auf ABAPforum.com schalten
kostenfrei für Ausbildungsberufe und Werksstudenten


Re: Erstellung eines Programmierhandbuchs

Beitrag von ralf.wenzel (Top Expert / 3776 / 176 / 262 ) »
Sowas ist nicht trivial. Erstens weil man oft wichtige Dinge vergisst (weil man denkt, es reicht, ein paar Namensregeln festzulegen) und zweitens weil man oft inkonsistent definiert. Außerdem wird gern Unwichtiges definiert, was die Arbeit der Entwickler oft mehr als nötig einschränkt.
cosmo hat geschrieben:Wer hat so was schon mal gemacht und könnte vielleicht eine Vorlage zur Verfügung stellen.


Ich habe sowas schon oft gemacht. Im Kundenauftrag zu meinem Stundensatz.

Zur Verfügung stellen? Du machst wohl Witze *lol*

ObJoke: Kann mir mal jemand nen Ferrari zur Verfügung stellen? Ich hätte gern einen, möchte ihn aber nicht bezahlen.
cosmo hat geschrieben:Oder gibt es von SAP hier irgendwas?
Nein. Die haben interne Regeln, die die aber auch nicht rausrücken. Schon weil die in den seltensten Fällen übertragbar sind.


Ralf
Bild
Ralf Wenzel Heuristika SAP-Development
25 Jahre SAP-Entwickler • 20 Jahre Freiberufler
PublikationenUngarische NotationXing

Beitrag von ewx (Top Expert / 4784 / 294 / 628 ) »
Hi Jörg,

das ist tatsächlich Arbeit, die man mit der Erstellung eines Programmierhandbuches hat.

Die Namenskonventionen kann man sich schnell von der SAP-Hilfe ins Dokument kopieren. Damit ist es aber eben nicht getan.

Was dann noch folgt ist wirklich stark von Firma zu Firma unterschiedlich.

Z.B: Wie und wo sollen Programme/ Transaktionen/ Queries dokumentiert werden? Word, Verzeichnis, spezielles Tool...?

Man kann auch festlegen,
- dass Inserts und Updates immer in Funktionsbausteinen gekapselt werden müssen,
- dass global definierte Variablen immer mit "G für Global" beginnen müssen,
- dass Programme alle paar Zeilen eine erklärende Bemerkung enthalten müssen,
- dass Programme immer einen bestimmten Programmkopf haben müssen, indem Ersteller, Grund, zuständige Person etc. erscheinen muss,
- dass Programme für den Batchbetrieb mit Z_BTC beginnen müssen, Einmalprogramme mit Z_ONE, Schnittstellenprogramme mit Z_MIG etc
- dass Methodennamen und Funktionsbausteine einen sprechenden Namen haben sollten
- dass Programme so erstellt werden müssen, dass sie übersetzt werden können
- dass SELECT-ENDSELECT-Konstrukte verboten sind
- dass das dass

Man kann sich da herrlich auslassen... :lol:

Allerdings gehört dann auch immer jemand dazu, der die Vorgaben kontrolliert... 8)

Manches lässt sich auch einfach nicht vorgeben, so schön es auch wäre. Jeder Programmierer hat seinen eigenen Stil und Programmierer sind merkwürdige Wesen... :D

Auf jeden Fall ist es hilfreich, wenn in so einem Dokument die wichtigsten Namenskonventionen aufgelistet sind und ein paar Tricks und Hinweise zur saueberen und performanten Programmierung stehen. Evtl. auch Funktionen, die häufig benutzt werden können (Popups, Baustein zum Lesen von Materialien, Texten, etc) oder spezielle Bausteine des Kunden, die wichtige Eigenarten aufzeigen.

In jedem Fall ist das etwas, was man nicht einfach kopieren kann, sondern man muss es tatsächlich erarbeiten.

Viel Spaß! :lol:

Beitrag von ralf.wenzel (Top Expert / 3776 / 176 / 262 ) »
ewx hat geschrieben:- dass global definierte Variablen immer mit "G für Global" beginnen müssen,
....und zwar nur da, wo es nicht anders geht, ansonsten gehören sie verboten. Und der Hinweis auf eine Änderungshistorie fehlt noch. Undokumentierte Objekte (Online-Doku!) gehören nicht produktiv gesetzt.

Und ja, man brauche eine Prüfinstanz, bei meinem derzeitigen Kunden ist das absolut vorbildlich gelöst. Bei der Bundesbank, wo ich ein bisschen Einblick habe, ebenfalls.

Man kann übrigens keine Regelungen treffen, die von den Programmierern nicht getragen werden. Das Vermitteln ist ebenso wichtig wie das Definieren und Kontrollieren dieser Regeln.

In zwei Worten: Klassisches Beratergeschäft *lol*


Ralf
Bild
Ralf Wenzel Heuristika SAP-Development
25 Jahre SAP-Entwickler • 20 Jahre Freiberufler
PublikationenUngarische NotationXing

Seite 1 von 1

Vergleichbare Themen

1
Antw.
3237
Views
TA Erstellung : Userexit
von verzweifelt » 10.06.2015 19:38 • Verfasst in Material Management & Produktionsplanung
0
Antw.
1276
Views
TA-Erstellung und Kontierung
von dkast » 10.08.2018 10:43 • Verfasst in ABAP® Core
6
Antw.
3778
Views
PDF Erstellung mit CONVERT_OTFSPOOLJOB_2_PDF
von chfreise » 03.04.2008 15:47 • Verfasst in ABAP® Core
1
Antw.
1526
Views
Erstellung von Testdaten
von airwaver » 21.02.2008 07:59 • Verfasst in ABAP® Core
1
Antw.
4104
Views
autom. TA Erstellung
von Desc » 10.08.2007 15:15 • Verfasst in Material Management & Produktionsplanung

Über diesen Beitrag


Unterstütze die Community und teile den Beitrag für mehr Leser und Austausch

Newsletter Anmeldung

Keine Beiträge verpassen! Wöchentlich versenden wir lesenwerte Beiträge aus unserer Community.
Die letzte Ausgabe findest du hier.
Details zum Versandverfahren und zu Ihren Widerrufsmöglichkeiten findest du in unserer Datenschutzerklärung.