Programmfunktion

Programmfunktion und Daten

Eine Programmfunktion berechnet aus einer Eingabe (beschrieben durch "Ausgangssituation") eine Ausgabe (beschrieben durch "Ergebnis").

Steuerdaten(beschrieben durch "Parametrierung") sind Daten, die von der Programmfunktion ausschließlich lesend verwendet werden und die für viele Aufrufe der Funktion gleich sind.

Ändert eine Programmfunktion die Alex^®-Daten, ist das eine Transition. Solange die Transition nicht abgespeichert ist,

• kann sie rückgängig gemacht werden.
• sind die von ihr geänderten Daten gesperrt, damit keine gleichzeitige Änderung in anderen Sitzungen möglich ist.

Es können beliebig viele Transitionen durchgeführt werden, bevor abgespeichert wird. Nach dem Speichern sind die Änderungen in anderen Sitzungen sichtbar.

Ändert die Programmfunktion keine Daten, da sie ausschließlich eine Ansicht berechnet, ist das eine Anzeigefunktion.

Wird im Alex^®Wiki von einer Funktion oder Programmfunktion gesprochen, ist stets eine Transition gemeint. Ist eine Anzeigefunktion gemeint, wird das ausdrücklich ausgeschrieben.

Struktur eines Artikels für Programmfunktion

• Abstract
• Überschrift (==): Aufruf der Funktion (optional)
• Überschrift (==): Funktionsbeschreibung
  • Unterüberschrift1 (===): Unterschritt1
    • Unterüberschrift2 (====): Unterschritt1.1
    • Unterüberschrift2 (====): Unterschritt1.2...
  • Unterüberschrift1 (===) Unterschritt2..
• Überschrift (==): Parametrierungsrichtlinien
• Überschrift (==): Beispiele
  • Unterüberschrift1 (===): Beispieltitel1 + Absatz Einleitung
    • Unterüberschrift2 (====): Ausgangssituation Bild + Beschreibung + Link zu DemoDB mit beschriebener Ausgangssituation
    • Unterüberschrift2 (====): Parametrierung Bild + Beschreibung
    • Unterüberschrift2 (====): Ergebnis Bild + Beschreibung
  • Unterüberschrift1 (===) Beispieltitel2 ...
• Überschrift (==): Config-File <- wenn nötig
  • Link zu eigner Seite für Beschreibung von Configfile Einstellungen("intern:")

Beispiele für Dokumentation Programmfunktion

• Abschlussbuchungen
• Indikatoren
• Schemaanpassung

Vorlage DB für Beispiele

DokuDBStart

Links:

Grafik Rohdaten