Codeblock

Die Direktive code ermöglicht es, Codebereiche im Kommentar darzustellen. Diese werden im Bibliotheksverwalter grau schattiert und in Konstantschrift mit farblich hervorgehobener Syntax angezeigt.

Beschreibung

Die Direktivenmarkierung besteht aus einem expliziten Markup-Start („.. “) gefolgt vom Typ der Direktive (code) und zwei Doppelpunkten.

(Siehe auch: Direktiven)

Prinzip

.. code::

Eigenschaften

Zwischen der Direktive und einem vorangehenden Textkörperelement (z. B. einem Absatz mit Text) ist eine Leerzeile notwendig.

Optionen

Optional kann ein Direktivenblock eine flache Liste mit Code-Optionen enthalten. Folgende Option wird erkannt:

Number-lines : [start line number]

Jeder Zeile wird eine Zeilennummer vorangestellt. Das optionale Argument ist die Nummer der ersten Zeile. Standardwert ist 1.

Die Syntax wird in diesem Fall nicht farblich hervorgehoben.

Beispiele

(Im Beispielprojekt: B_DocuElements\Code Block\FB_Libdoc_CodeBlock)

Codeblock mit farblich hervorgehobener Syntax

(*
.. code:: 
    
    // Attempts to return the value of a boolean property.
   
    FUNCTION GetBooleanProperty : BOOL
    VAR_INPUT
        sKey: STRING;
    END_VAR

    // This structure defines a special profile.

    TYPE ST_Profile :
    STRUCT
        nId     : INT := -1;
        sBuffer : STRING(255) := 'Hello';
    END_STRUCT
    END_TYPE
*)

Codeblock 1:

Codeblock mit Zeilennummerierung

(*
.. code:: 
   :number-lines: 1
    
    // Attempts to return the value of a boolean property.
   
    FUNCTION GetBooleanProperty : BOOL
    VAR_INPUT
        sKey: STRING;
    END_VAR

    // This structure defines a special profile.

    TYPE ST_Profile :
    STRUCT
        nId     : INT := -1;
        sBuffer : STRING(255) := 'Hello';
    END_STRUCT
    END_TYPE
*)

Codeblock 2: