Das Kommando Brickdokumentation und seine speziellen Unterkommandos dienen zur einheitlichen Dokumentation eines Bricks. Das Kommando wird bei Neuerstellung eines Bricks automatisch am Anfang eingefügt. Wird die Dokumentation nicht benötigt, kann das Kommando oder einzelne Unterkommandos einfach aus dem Brick gelöscht werden. Folgende Unterkommandos sind erlaubt:
- Titel: (optional) Mit diesem Kommando kann ein Titel als Parameter angegeben werden, der den Brick kurz beschreibt.
- Beschreibung: (optional) Mit diesem Kommando kann eine längere Beschreibung eingegeben werden. Das Kommando kann auch mehrfach wiederholt werden.
- Geändert: (optional) Damit kann eine Historie der Brick Änderungen geführt werden. Das Kommando kann mehrfach wiederholt werden und hat als Parameter das Änderungsdatum, den Benutzer und die Beschreibung der Änderung.
- Übergabeparameter: (optional) Hier können die Übergabeparameter beschrieben werden. Als Unterkommando können mehrere Felder und/oder Datenobjekte samt Beschreibung angegeben werden. Die Auswahl der Felder und Datenobjekte erfolgt dabei über den Feldeditor. Das hat den praktischen Vorteil, dass die hier definierten Felder auch in der Feldauswahl (auch via Checkbox: nur Felder des Brick anzeigen) auswählbar sind.
- Unter den Übergabeparametern: Datenobjekt: (optional) Hier können Datenobjekte definiert werden, welche übergeben werden.
- Unter den Übergabeparametern: Feld: (optional) Hier können Felder definiert werden, welche übergeben werden.
- Rückgabewerte: (optional) Hier können die Rückgabewerte, analog zu den Übergabeparametern beschrieben werden.
- Unter den Rückgabewerten: Datenobjekt: (optional) Hier können Datenobjekte definiert werden, welche zurückgegeben werden.
- Unter den Rückgabewerten: Feld: (optional) Hier können Felder definiert werden, welche zurückgegeben werden.
