屏蔽评论

借助屏蔽评论功能,用户可以对屏蔽内容添加评论。与基于文本的编程语言中的注释一样,这些注释不会影响代码块的行为。标准语言代码生成器会将它们添加到生成的代码(包括由自定义块生成的代码)中。

带有注释的 if 块

“评论”图标

用户可以使用评论图标的文本编辑器输入分块评论。

默认情况下,系统不会显示评论图标。您可以通过以下两种方式显示此信息:

  • 使用非 null 字符串调用 Block.setCommentText
  • 让用户点击屏幕截图内容菜单中的“添加评论”即可显示评论。

如要移除评论图标,请执行以下操作:

  • 使用 null 调用 Block.setCommentText
  • 让用户通过点击屏蔽内容的上下文菜单中的“移除评论”来移除评论。

请注意,只有在满足以下条件时,上下文菜单中才会显示“添加评论”和“移除评论”:

  • 该代码块是可修改的。
  • 该代码块未收起。
  • 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 配置选项设置的影响。