コメントをブロックする

ブロックコメントを使用すると、ユーザーはブロックにコメントを追加できます。テキストベースのプログラミング言語のコメントと同様に、ブロックの動作には影響しません。これらは、標準言語コード生成ツールによって生成されたコード(カスタム ブロックによって生成されたコードを含む)に追加されます。

コメント付きの if ブロック

コメント アイコン

ユーザーは、コメント アイコンのテキスト エディタを使用してブロックコメントを入力します。

デフォルトでは、コメント アイコンは表示されません。表示方法は次の 2 つです。

  • null 以外の文字列で Block.setCommentText を呼び出します。
  • ブロックのコンテキスト メニューで [コメントを追加] をクリックして、ユーザーがコメントを表示できるようにします。

コメント アイコンを削除するには:

  • nullBlock.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 構成オプションの設定の影響を受けません。