Блокировать комментарии

Комментарии к блоку позволяют пользователям добавлять комментарии к блоку. Подобно комментариям в текстовом языке программирования, они не влияют на поведение блока. Они добавляются в сгенерированный код (включая код, сгенерированный пользовательскими блоками) генераторами кода стандартного языка.

Значок комментария

Пользователи вводят комментарии к блоку с помощью текстового редактора значка комментария.

По умолчанию значок комментария не отображается. Есть два способа его отображения:

• Вызовите Block.setCommentText с ненулевой строкой.
• Позвольте пользователю отобразить его, нажав «Добавить комментарий» в контекстном меню блока.

Чтобы удалить значок комментария:

• Вызовите Block.setCommentText с null .
• Позвольте пользователю удалить его, нажав «Удалить комментарий» в контекстном меню блока.

Обратите внимание, что «Добавить комментарий» и «Удалить комментарий» отображаются в контекстном меню только в том случае, если:

• Блок доступен для редактирования .
• Блок не разрушен.
• Для параметра конфигурации comments установлено значение true . Если вы не задали этот параметр явно, он по умолчанию будет иметь значение true если в наборе инструментов есть категории, false в противном случае.

Программная работа с комментариями блоков

Чтобы получить комментарий к блоку:

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

Чтобы установить комментарий к блоку:

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

Чтобы удалить комментарий к блоку:

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

На возможность программной работы с комментариями не влияет состояние блока (например, доступен ли он для редактирования или свернут) или настройка параметра конфигурации comments .