Ansicht
Dokumentation

ABENCOMMENT_LANGU_GUIDL - COMMENT LANGU GUIDL

TXBHW - Original Tax Base Amount in Local Currency   Addresses (Business Address Services)  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Kommentarsprache

Programme englisch kommentieren

Verfassen Sie die Kommentare in ABAP-Programmen ausschließlich in englischer Sprache, damit ein möglichst großer Leserkreis sie verstehen und von ihnen profitieren kann.

Englischsprachige Kommentare sind eine Grundvoraussetzung für eine verteilte Entwicklung auf internationaler Ebene. Daneben gibt es weitere gute Gründe für Englisch als Kommentarsprache:

• Die Anweisungen eines ABAP-Programms können wenn Namen in englischer Sprache werden, mit etwas gutem Willen als englischsprachige Sätze gesehen werden. Für den Leser fügen sich daher englischsprachige Kommentare am besten in den Quelltext ein. Bei anderssprachigen Kommentaren ergäbe sich ein ständiger Wechsel zwischen verschiedenen Sprachen, der selbst für Leser, die der verwendeten Sprache mächtig sind, ermüdend ist.

• Die unerwünschten nacherzählenden Kommentare sind häufig den zu beschreibenden ABAP-Anweisungen sehr ähnlich, wenn sie in englischer Sprache verfasst werden. Auf diese Weise wird es dem Autor schneller bewusst, dass er gerade einen überflüssigen Kommentar verfasst.

Ausnahme

Fachbegriffe, die beispielsweise einer länderspezifischen Gesetzesgebung entspringen (wie etwa "Abgeltungssteuer" im Deutschen), oder bestimmte Abkürzungen (wie etwa "DÜVO") lassen sich nicht sinnvoll ins Englische übersetzen, bzw. sind dann nicht mehr wiederzuerkennen. Solche Begriffe sollten daher in Anführungszeichen gesetzt und nicht ins Englische übersetzt werden. Hierbei ist in jedem Fall zu beachten, dass länderspezifische Zeichen durch 7-Bit-ASCII-Zeichen zu ersetzten sind. Ziel von obiger Regel ist es, einem möglichst großen Adressatenkreis das Nachvollziehen des Programmablaufs zu ermöglichen. Dies ist auch dann möglich, wenn IT-fremde Spezialbegriffe in einer anderen Sprache formuliert sind.

Hinweis

Diese Regel gilt unabhängig von der Wahl der Originalsprache.

Folgender Quelltext zeigt ein typisches Beispiel für deutsche Kommentare, in die englische Begriffe eingemischt sind, die dann meistens nicht einmal der vorgeschriebenen Schreibweise bzw. Terminologie folgen.

"Horizontales Splittercontrol im Hilfecontainer
CREATE OBJECT splitter_h
  EXPORTING
    parent = help_container
    rows = 1
    columns = 2.

"Vertikales Splittercontrol im linken Container
CREATE OBJECT splitter_v
  EXPORTING
    parent = container_left
    rows = 2
    columns = 1.

Folgender Quelltext zeigt obigen Quelltext mit den durch obige Regel geforderten englischen Kommentaren.

  "Horizontal splitter control in help container
CREATE OBJECT splitter_h
  EXPORTING
    parent = help_container
    rows = 1
    columns = 2.

  "Vertical splitter control in left container
CREATE OBJECT splitter_v
  EXPORTING
    parent = container_left
    rows = 2
    columns = 1.

Dieses Beispiel soll nur den Unterschied zwischen deutscher und englischer Kommentierung aufzeigen. Wären die Bezeichner sprechender gewählt, also splitter_horizontal statt splitter_h etc., könnte man nach der folgenden Regel auch vollständig auf die Kommentare verzichten.

rdisp/max_wprun_time - Maximum work process run time   RFUMSV00 - Advance Return for Tax on Sales/Purchases  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 4577 Date: 20240523 Time: 164847     sap01-206 ( 72 ms )