Kommentare in Programmen

Kommentare in Programmen sind in aller Regel sehr hilfreich für das Verständnis eines Programms.

Beantwortung Fragen

• Wozu ist ein Programm da?
• Wie arbeitet das Programm?
• Welche Änderungen am Programm sind wann, von wem und warum vorgenommen worden?

Unterscheidung Kommentare

• Kommentarkopf
• Kommentare zu Funktionseinheiten des Programms
• Kommentare mit sprechenden Bezeichnungen von Datenobjekten
• Kommentare zu Programmänderungen

Kommentarkopf

Jedes eigene Programm sollte einen standardisierten Kommentarkopf haben. Hier ist vor allem die Funktionsbeschreibung des Programms entscheidend. Der Entwickler, der mit dem Programm nicht vertraut ist, kann so mit einem Blick erfassen, warum das Programm geschrieben wurde und welche großen Änderungen wurden nach dem ersten Produktivtransport noch vorgenommen.

Kommentarkopfvorlage

************************************************************************
* Programmname...............:                                         *
* Autor......................:  René Eberstein                         *
* Firma......................:  Eberstein Consulting                   *
* Projekt....................:                                         *
* Aufgabe....................:                                         *
* Ansprechpartner Fachabt....:                                         *
* Erstellt am................:                                         *
* Kopiert von................:                                         *
* Online/Batch/USER-EXIT ....:  Online                                 *
* Funktionsbeschreibung .....:                                         *
*                                                                      *
*                                                                      *
*                                                                      *
*----------------------------------------------------------------------*
*& Änderungen:                                                         *
*&                                                                     *
*----------------------------------------------------------------------*
*& "REB201:                                                            *
*&                                                                     *
*&---------------------------------------------------------------------*

Änderungskommentare

Änderungen an einem Programm sollten festgehalten werden, sofern das Programm bereits im Produktivsystem läuft und grundsätzlich nicht mehr sehr viele Änderungen an dem Programm erfolgen, ansonsten würde bei der Masse an Änderungskommentaren die Übersicht verloren gehen.

Größere/Bedeutende Änderungen im Programm sollten auch im Kommentarkopf festgehalten werden

 *& Änderungen:                                                         *
 *&                                                                     *
 *----------------------------------------------------------------------*
 *& "REB20110108 - Selektionsbildschirmbezeichnungen überarbeitet       *
 *&                                                                     *
 *&---------------------------------------------------------------------*

Wenn es im Coding eine Zeile betrifft, kann man die Änderung an das Zeilenende hängen. Hier ist ein Personenkürzel, ein Änderungsdatum und ein kurzer Kommentar zum Inhalt der Änderung sinnvoll

...           "REB20110108 - Selektionsbildschirmbezeichnungen überarbeitet 

Wenn die Änderung mehrere aufeinanderfolge Zeilen betrifft, kann man den Anfang und das Ende der Änderung kommentieren

* begin of REB20110108 - Selektionsbildschirmbezeichnungen überarbeitet 
  ...
  ...
  ...
* end of REB20110108 - Selektionsbildschirmbezeichnungen überarbeitet

Anpassung Programmvorlagen

• Anpassung der Vorlage für ein Programm, dokumentiert im Tricktresor.

Kommentare zu Funktionseinheiten des Programms

Wenn eine Funktionseinheit (Form-Routine, Methode, Aufruf Funktionsbaustein etc.) folgt, dann sollte dieser Funktionseinheit ein kurzer Kommentar vorangehen.

****************************
* Upload in itab as string *
****************************
  PERFORM upload
    USING    p_file
    CHANGING gt_upload.

Kommentare zu Datenobjekten

Sehr häufig werden in SAP-Programmen Dictionary-Objekte, wie Felder von Tabellen gelesen, bzw. verarbeitet. Auch wenn diese Bezeichnungen über SE11 nachgeschlagen werden können, hilft es beim Lesefluss, die Bezeichnungen gleich hinter die entsprechen Objekte zu schreiben.

Es ist auch ein guter Einstieg in ein fremdes Programm, um es zu verstehen, wenn man diese Objekte kommentiert.

Select
 vbeln            "Kundenauftrag
 kunnr            "Kundennummer
 from vbak        "Kundenauftragkopf
 inner join vbap  "Kundenauftragsposition
 ...