Los comentarios bloqueados permiten que los usuarios agreguen comentarios a un bloque. Al igual que los comentarios en un lenguaje de programación basado en texto, no afectan el comportamiento de un bloque. Los generadores de código de lenguaje estándar los agregan al código generado (incluido el código generado por bloques personalizados).
El ícono de comentario
Los usuarios ingresan comentarios de bloqueo con el editor de texto del ícono de comentarios.
De forma predeterminada, no se muestra el ícono de comentario. Existen dos maneras de mostrarlo:
- Llama a
Block.setCommentTextcon una cadena no nula. - Para permitir que el usuario lo muestre, haz clic en “Agregar comentario” en el menú contextual del bloque.
Para quitar el ícono de comentario, haz lo siguiente:
- Llama a
Block.setCommentTextcon unnull. - Para permitir que el usuario lo quite, haz clic en "Quitar comentario" en el menú contextual del bloque.
Ten en cuenta que las opciones “Agregar comentario” y “Quitar comentario” se muestran en el menú contextual solo en los siguientes casos:
- El bloque es editable.
- El bloque no se contrae.
- La opción de configuración
commentsestá configurada comotrue. Si no configuras esta opción de forma explícita, el valor predeterminado serátruesi la caja de herramientas tiene categorías,falsede lo contrario.
Cómo trabajar con comentarios de bloque de forma programática
Para obtener un comentario de bloqueo, sigue estos pasos:
// Returns comment text or null if there is no comment.
myBlock.getCommentText();
Para establecer un comentario de bloqueo, sigue estos pasos:
// Sets comment text and displays comment icon.
myBlock.setCommentText('My comment');
Para borrar un comentario de bloque, haz lo siguiente:
// Removes comment text and removes comment icon.
myBlock.setCommentText(null);
La capacidad de trabajar con comentarios de forma programática no se ve afectada por el estado del bloque (por ejemplo, si es editable o colapsado) ni por la configuración de la opción de configuración comments.