Bloquer les commentaires

Les commentaires sur les blocs permettent aux utilisateurs d'ajouter des commentaires à un bloc. Comme les commentaires dans un langage de programmation basé sur du texte, ils n'affectent pas le comportement d'un bloc. Ils sont ajoutés au code généré (y compris le code généré par des blocs personnalisés) par les générateurs de code de langage standard.

Icône Commentaire

Les utilisateurs saisissent les commentaires de blocage à l'aide de l'éditeur de texte de l'icône de commentaire.

Par défaut, l'icône de commentaire ne s'affiche pas. Vous pouvez l'afficher de deux façons:

• Appelez Block.setCommentText avec une chaîne non nulle.
• Autorisez l'utilisateur à l'afficher en cliquant sur "Ajouter un commentaire" dans le menu contextuel du bloc.

Pour supprimer l'icône de commentaire:

• Appelez Block.setCommentText avec un null.
• Autorisez l'utilisateur à le supprimer en cliquant sur"Supprimer le commentaire" dans le menu contextuel du blocage.

Notez que les options "Ajouter un commentaire" et "Supprimer un commentaire" ne s'affichent dans le menu contextuel que si:

• Le bloc est modifiable.
• Le bloc n'est pas réduit.
• L'option de configuration comments est définie sur true. Si vous ne définissez pas explicitement cette option, elle est définie par défaut sur true si la boîte à outils comporte des catégories, et sur false dans le cas contraire.

Utiliser des commentaires de bloc par programmation

Pour obtenir un commentaire de blocage:

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

Pour définir un commentaire à bloquer:

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

Pour supprimer un commentaire de bloc:

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

La possibilité de travailler avec des commentaires de manière programmatique n'est pas affectée par l'état du bloc (par exemple, s'il est modifiable ou réduit) ni par le paramètre de l'option de configuration comments.