Code-Dokumentation

Kommentare

Um den Makrocode kommentieren zu können bietet der Makrointerpreter zwei Möglichkeiten:

• Das Rufzeichen ! für einzeilige Kommentare

• Kommentarblockbeginn /* und Kommentarblockende */ für mehrzeilige Kommentare

Beispiel:

/* ----------------------------------------------------

Dieser Kommentar geht über mehrere Zeilen

Zeile2

Zeile3

---------------------------------------------------- */

!RAM_TR = 10 Auskommentierte Zeile

!Verschachtelungen von Kommentarblöcken sind nicht zulässig!

Regions

Regions sind dazu da um den Programmcode übersichtlicher zu gestalten. Wie von C# oder anderen Programmiersprachen bekannt, kann man einzelne Abschnitte wie Prozeduren kennzeichnen, damit man diese dann je nach Bedarf auf- oder zuklappen kann:

!REGION SetDefaultPreferences

!REGION Description

!+-------------------------------------------------------------------------------------------+

!| Name:                   SetDefaultPreferences

!| Purpose:                                 Sets the default settings which are necessary for each project

!| Parameters:  -

!| Example:     RUN moveit\general.SetDefaultPreferences

!+-------------------------------------------------------------------------------------------+

!ENDREGION

!REGION Procedure

PROCEDURE SetDefaultPreferences

GSERVER = TRUE

RUNTIMECHANGE = TRUE

ADJUSTGAPATRUNTIME = TRUE

ACTIVATEREFERENCES = TRUE

!pricecalcatruntime = TRUE

END

!ENDREGION

!ENDREGION

Das sieht dann folgendermaßen aus:

Durch Klicken auf das Minus-Symbol kann man die Regions zuklappen:

oder durch Klicken auf das Plus-Symbol diese wieder aufklappen: