Os comentários de bloco permitem que os usuários adicionem comentários a um bloco. Assim como os comentários em uma linguagem de programação baseada em texto, eles não afetam o comportamento de um bloco. Elas são adicionadas ao código gerado (incluindo o código gerado por blocos personalizados) pelos geradores de código de linguagem padrão.
Ícone de comentário
Os usuários inserem comentários em bloco com o editor de texto do ícone de comentários.
Por padrão, o ícone de comentário não é exibido. Há duas maneiras de exibir:
- Chame
Block.setCommentText
com uma string não nula. - Permita que o usuário o mostre clicando em "Adicionar comentário" no menu de contexto do bloco.
Para remover o ícone de comentário:
- Chame
Block.setCommentText
com umnull
. - Permita que o usuário remova o comentário clicando em "Remove Comment" no menu de contexto do bloco.
As opções "Adicionar comentário" e "Remover comentário" só aparecem no menu de contexto se:
- O bloco é editável.
- O bloco não está fechado.
- A opção de configuração
comments
está definida comotrue
. Se você não definir essa opção explicitamente, o padrão serátrue
se a caixa de ferramentas tiver categorias. Caso contrário, seráfalse
.
Trabalhar com comentários de bloco de maneira programática
Para criar um comentário de bloco:
// Returns comment text or null if there is no comment.
myBlock.getCommentText();
Para definir um comentário de bloco:
// Sets comment text and displays comment icon.
myBlock.setCommentText('My comment');
Para excluir um comentário de bloco:
// Removes comment text and removes comment icon.
myBlock.setCommentText(null);
A capacidade de trabalhar com comentários de forma programática não é afetada pelo estado
do bloco (como se ele é editável ou fechado) ou pela configuração da
opção de configuração comments
.