• Header exxsens Developer Blog

Dokumentationen von Programmänderungen

Im vorherigen Artkel haben wir unseren Header für Programmeinheiten vorgestellt. In der Wartung und Weiterentwicklung stellt sich dann oft die Frage, wie mit zu änderndem Programmcode umgegangen werden soll.

​Als Vorgabe für unsere eigenen Entwicklungen haben wir daher definiert:

  • ​jede Änderung ist mit einer neuen Änderungsnummer im Header anzulegen
  • im Header wird das Datum, die User-ID, eine etwaige Ticketnummer zum Programmfehler/ Weiterentwicklung sowie eine Beschreibung der Änderung aufgeführt
  • nach Möglichkeit sollte im Programmcode eine Änderung durch einen erklärenden Kommentar kenntlich gemacht werden
  • die nach einer Programmänderung nicht mehr benötigten Programmzeilen werden nicht auskommentiert, sondern gelöscht

Gerade im letzten Punkt gibt es oft 2 unterschiedliche Meinungen wie hiermit umzugehen ist.  Für uns haben wir entschieden, dass über die Versionen der Programme und die Möglichkeiten diese zu Vergleichen das nicht mehr benötigte Coding gelöscht werden soll. um die Lesbarkeit des Programms zu erhöhen.​

Sometimes ABAP ...
Header für Progamme / Methoden / Funktionsbaustein...

Ähnliche Beiträge

Empfehlen Sie uns weiter