Kommentare blockieren

Mit Blockkommentaren können Nutzer einem Block Kommentare hinzufügen. Wie Kommentare in einer textbasierten Programmiersprache haben sie keinen Einfluss auf das Verhalten eines Blocks. Sie werden dem generierten Code (einschließlich Code, der von benutzerdefinierten Blöcken generiert wird) von den Codegeneratoren der Standardsprache hinzugefügt.

Ein If-Block mit einem Kommentar

Das Kommentarsymbol

Nutzer geben Blockkommentare über den Texteditor des Kommentarsymbols ein.

Standardmäßig wird das Kommentarsymbol nicht angezeigt. Es gibt zwei Möglichkeiten, sie anzuzeigen:

  • Rufen Sie Block.setCommentText mit einem nicht nullwertigen String auf.
  • Der Nutzer kann sie anzeigen lassen, indem er im Kontextmenü des Blocks auf „Kommentar hinzufügen“ klickt.

So entfernst du das Kommentarsymbol:

  • Rufen Sie Block.setCommentText mit einem null an.
  • Der Nutzer kann den Kommentar entfernen, indem er im Kontextmenü des Blocks auf „Kommentar entfernen“ klickt.

Die Optionen „Kommentar hinzufügen“ und „Kommentar entfernen“ werden nur in folgenden Fällen im Kontextmenü angezeigt:

  • Der Block ist bearbeitbar.
  • Der Block ist nicht minimiert.
  • Die Konfigurationsoption comments ist auf true festgelegt. Wenn Sie diese Option nicht explizit festlegen, wird standardmäßig true verwendet, wenn die Toolbox Kategorien enthält, andernfalls false.

Blockkommentare programmatisch verarbeiten

So erhalten Sie einen Blockkommentar:

// Returns comment text or null if there is no comment.
myBlock.getCommentText();

So legen Sie einen Blockkommentar fest:

// Sets comment text and displays comment icon.
myBlock.setCommentText('My comment');

So löschen Sie einen Blockkommentar:

// Removes comment text and removes comment icon.
myBlock.setCommentText(null);

Die Möglichkeit, programmatisch mit Kommentaren zu arbeiten, wird weder vom Status des Blocks (z. B. ob er bearbeitbar oder minimiert ist) noch von der Einstellung der Konfigurationsoption comments beeinflusst.