ABAP Clean Code
Hallo Kollegen,
SAP hat unter Github ABAP Styleguides abgelegt zur öffentlichen Beachtung und am Besten auch Befolgung.
https://github.com/SAP/styleguides/blob ... eanABAP.md
Viel Spaß beim Lesen. Bin gespannt auf aufkommende Diskussionen! :)
SAP hat unter Github ABAP Styleguides abgelegt zur öffentlichen Beachtung und am Besten auch Befolgung.
https://github.com/SAP/styleguides/blob ... eanABAP.md
Viel Spaß beim Lesen. Bin gespannt auf aufkommende Diskussionen! :)
gesponsert ⓘ
Stellenangebote auf ABAPforum.com schalten
kostenfrei für Ausbildungsberufe und Werksstudenten
kostenfrei für Ausbildungsberufe und Werksstudenten
Beitrag
von black_adept (Top Expert / 4080 / 125 /
935
)
»
Das Schlimmste ist diese dort verlinkte Seite - und die Meisten werden wissen warum!
Folgende Benutzer bedankten sich beim Autor black_adept für den Beitrag:
Romaniac
Ist doch eine erfreuliche Entwicklung.
Bleibt nur zu hoffen, dass die SAP sich auch an diesen Styleguide hält :-)
Bleibt nur zu hoffen, dass die SAP sich auch an diesen Styleguide hält :-)
Publikationen:
Qualitätsmanagement in der ABAP-Entwicklung,
Why we should take care about clean code
ABAP, Java, JavaScript
GitHub
Qualitätsmanagement in der ABAP-Entwicklung,
Why we should take care about clean code
ABAP, Java, JavaScript
GitHub
This kind of prefixing is a relic from the early days of programming, when code was printed out and read on paper, and you didn't want to flip around just to find some variable's type. Modern development environments give easy access to data types, signatures, and object navigation, such that it is no longer needed to get readable code.
Kann man nicht oft genug wiederholen.
Kann man nicht oft genug wiederholen.
Beitrag
von ralf.wenzel (Top Expert / 3921 / 200 /
280
)
»
Jetzt möchte ich mal sehen, ob die DSAG ihre Programmierrichtlinien nicht doch noch modernisiert (die raten zu intensiver Nutzung der Ungarischen Notation, wenigstens führen sie auf, dass es auch andere Meinungen dazu gibt - dabei verlinken sie auf meinen SDN-Artikel).
Das ist Coding aus der Hölle.
Ralf
Das ist Coding aus der Hölle.
Ralf
Ralf Wenzel • Heuristika SAP-Development
25 Jahre SAP-Entwickler • 20 Jahre Freiberufler
Publikationen • Ungarische Notation • Xing
SAP > DSAG
Aber klar, viele richten sich nach der DSAG. Hoffe auch, dass die es ändern. Und unsere Firma hoffentlich auch.
Finde viele Sachen gut, mit allem bin ich nicht einverstanden.
Zum Beispiel finde ich es besser, für alle Membervariablen auch wirkliche Getter zu schreiben, statt sie public read only zu machen:
https://github.com/SAP/styleguides/blob ... -of-getter
Aber klar, viele richten sich nach der DSAG. Hoffe auch, dass die es ändern. Und unsere Firma hoffentlich auch.
Finde viele Sachen gut, mit allem bin ich nicht einverstanden.
Zum Beispiel finde ich es besser, für alle Membervariablen auch wirkliche Getter zu schreiben, statt sie public read only zu machen:
https://github.com/SAP/styleguides/blob ... -of-getter
Beitrag
von black_adept (Top Expert / 4080 / 125 /
935
)
»
Was ist eigentlich die beste Alternative um dann Verschattungen von Variablen möglichst zu verhindern? Das hatte bei Verwendung der HN durch den 1. Buchstaben eigentlich recht gut geklappt und der Syntaxcheck würde bei Präfixen das folgende Beispiel nicht durchgehen lassen.
Beispiel: Was kommt als Ausgabe beim folgenden Programm raus?
Beispiel: Was kommt als Ausgabe beim folgenden Programm raus?
Code: Alles auswählen.
REPORT.
DATA: testvariable1 TYPE sydatum,
testvariable2 TYPE sydatum.
PERFORM test CHANGING testvariable1 testvariable2.
WRITE:/ testvariable1, testvariable2.
FORM test CHANGING cv_datum1 TYPE sydatum cv_datum2 TYPE sydatum.
DATA: testvariablel TYPE sydatum,
testvariable2 TYPE sydatum.
testvariablel = sy-datum + 10.
testvariable2 = sy-datum + 20.
cv_datum1 = testvariable1.
cv_datum2 = testvariable2.
ENDFORM. "testDa kommt 0 und heute+20 raus.
Und wer so programmiert gehört entlassen.
Und wer so programmiert gehört entlassen.
Folgende Benutzer bedankten sich beim Autor Daniel für den Beitrag (Insgesamt 2):
SaskuAc • DeathAndPain
Das ist eben eine schwäche die ABAP hat. aber mit guten OO funktioniert das zum Beispiel recht gut:black_adept hat geschrieben: ↑08.05.2019 09:23Was ist eigentlich die beste Alternative um dann Verschattungen von Variablen möglichst zu verhindern? Das hatte bei Verwendung der HN durch den 1. Buchstaben eigentlich recht gut geklappt und der Syntaxcheck würde bei Präfixen das folgende Beispiel nicht durchgehen lassen.
Beispiel: Was kommt als Ausgabe beim folgenden Programm raus?
Code: Alles auswählen.
CLASS lcl_test DEFINITION.
PUBLIC SECTION.
METHODS: abc IMPORTING test TYPE i.
METHODS: adc RETURNING VALUE(test) TYPE i.
PRIVATE SECTION.
DATA test TYPE i.
ENDCLASS.
CLASS lcl_test IMPLEMENTATION.
METHOD abc.
me->test = test.
ENDMETHOD.
METHOD adc.
test = me->test.
ENDMETHOD.
ENDCLASS.
START-OF-SELECTION.
DATA(bruuuh) = NEW lcl_test( ).
bruuuh->abc( 4 ).
WRITE bruuuh->adc( ).Das muss ja nicht immer böse Absicht sein...
Beitrag
von black_adept (Top Expert / 4080 / 125 /
935
)
»
@Daniel: Wenn du in einem fremden Programm weiterentwickeln musst - kennst du alle globalen Variablennamen und kannst du sicherstellen, dass dir nie ein Buchstabendreher unterläuft?
Beitrag
von black_adept (Top Expert / 4080 / 125 /
935
)
»
die durch konsequentes Handhaben von Präfixen behoben wird.
Und wenn man die Deklaration von statisch auf Instanz oder umgekehrt ändert ( was am Anfang einer Entwicklung durchaus von Zeit zu Zeit vorkommt ) müsste ich alle Aufrufstellen korrigieren. Versteh mich nicht falsch - es gibt gute Gründe genau so zu verfahren wie du - aber es gibt eben auch gute Gründe warum man eine saubere Präfixierung durchziehen möchte um diverse (andere) Probleme einfach zu umgehen
Das Problem im Beispiel ist nicht der 2 mal vergebene Variablenname ( in diesem Fall ist die Verschattung ja gewollt ) sondern der Buchstabendreher, der die Verschattung umgeht. Wenn es sich da um ein größeres Codekonglomerat handelt ist der Fehler schwer und spät (erst zur Laufzeit) zu finden. Obwohl alle nach bestem Wissen gehandelt haben kann hier ein Fehler auftauchen, der durch Präfixe und entsprechende SCI-Prüfungen im Vorfeld gefunden worden wäre.
Beitrag
von black_adept (Top Expert / 4080 / 125 /
935
)
»
@Daniel ACK. Aber du musst es finden bevor du es aufräumen kannst. Und da Namenskonventionen helfen solche (zugegeben recht seltenen aber doch von Zeit zu Zeit vorkommende ) Fehler automatisiert zu finden kann ich eben diese Präfixabneigung nicht teilen. Und das "this" des Zitats was du oben gepostet hast bezieht sich wahrscheinlich auf solche Präfixe die die Typisierung betreffen und nicht den Gültigkeitsbereich.
Frage zurück:
Wenn wir das Codebeispiel mit der ungarischen Notation gestaltet hätten, wie kann dann mit der statischen Syntaxprüfung die falsche Verwendung der Variable ausgeschlossen werden?
Ich kann ja immer noch in Gedanken das falsche Präfix verwenden:
Um Variablendreher, ungewollte Verschattungen usw. zu finden, verwenden wir schließlich Unit Tests.
Wenn wir das Codebeispiel mit der ungarischen Notation gestaltet hätten, wie kann dann mit der statischen Syntaxprüfung die falsche Verwendung der Variable ausgeschlossen werden?
Ich kann ja immer noch in Gedanken das falsche Präfix verwenden:
Code: Alles auswählen.
REPORT.
DATA: g_testvariable1 TYPE sydatum,
g_testvariable2 TYPE sydatum.
PERFORM test CHANGING g_testvariable1 g_testvariable2.
WRITE:/ g_testvariable1, g_testvariable2.
FORM test CHANGING cv_datum1 TYPE sydatum cv_datum2 TYPE sydatum.
DATA: l_testvariable1 TYPE sydatum,
l_testvariable2 TYPE sydatum.
g_testvariable1 = sy-datum + 10.
l_testvariable2 = sy-datum + 20.
cv_datum1 = l_testvariable1.
cv_datum2 = l_testvariable2.
ENDFORM. "test
Publikationen:
Qualitätsmanagement in der ABAP-Entwicklung,
Why we should take care about clean code
ABAP, Java, JavaScript
GitHub
Qualitätsmanagement in der ABAP-Entwicklung,
Why we should take care about clean code
ABAP, Java, JavaScript
GitHub
Vergleichbare Themen
3
Antw.
Antw.
2297
Views
Views
0
Antw.
Antw.
1691
Views
Views
Frage die ABAP Experten
Über diesen Beitrag
- nickname8
- black_adept
- jocoder
- Daniel
- ralf.wenzel
- SaskuAc
- ewx
- DeathAndPain
- ST22
- GastX
- deejey
- IHe
- a-dead-trousers
- erp-bt
- Icke0801
Unterstütze die Community und teile den Beitrag für mehr Leser und Austausch
Aktuelle Forenbeiträge
Nach Transport von Stellen über RHMOVE30 nur Planvariante "nie verwenden"
vor 15 Stunden von DeathAndPain 2 / 284
vor 15 Stunden von DeathAndPain 2 / 284
Newsletter Anmeldung
Keine Beiträge verpassen! Wöchentlich versenden wir lesenwerte Beiträge aus unserer Community.Die letzte Ausgabe findest du hier.
Aktuelle Forenbeiträge
Nach Transport von Stellen über RHMOVE30 nur Planvariante "nie verwenden"
vor 15 Stunden von DeathAndPain 2 / 284
vor 15 Stunden von DeathAndPain 2 / 284