Komentar blok memungkinkan pengguna menambahkan komentar ke blok. Seperti komentar dalam bahasa pemrograman berbasis teks, komentar tidak memengaruhi perilaku blok. Kode tersebut ditambahkan ke kode yang dihasilkan (termasuk kode yang dihasilkan oleh blok kustom) oleh generator kode bahasa standar.
Ikon komentar
Pengguna memasukkan komentar blok dengan editor teks ikon komentar.
Secara default, ikon komentar tidak ditampilkan. Ada dua cara untuk menampilkannya:
- Panggil
Block.setCommentText
dengan string non-null. - Izinkan pengguna menampilkannya dengan mengklik "Tambahkan Komentar" di menu konteks blok.
Untuk menghapus ikon komentar:
- Panggil
Block.setCommentText
dengannull
. - Izinkan pengguna menghapusnya dengan mengklik "Hapus Komentar" di menu konteks blok.
Perhatikan bahwa "Tambahkan Komentar" dan "Hapus Komentar" hanya ditampilkan di menu konteks jika:
- Blok ini dapat diedit.
- Blok tidak diciutkan.
- Opsi konfigurasi
comments
ditetapkan ketrue
. Jika Anda tidak menetapkan opsi ini secara eksplisit, opsi ini akan ditetapkan secara default ketrue
jika kotak alat memiliki kategori, ataufalse
jika tidak.
Menggunakan komentar blok secara terprogram
Untuk mendapatkan komentar blokir:
// Returns comment text or null if there is no comment.
myBlock.getCommentText();
Untuk menetapkan komentar blok:
// Sets comment text and displays comment icon.
myBlock.setCommentText('My comment');
Untuk menghapus komentar blok:
// Removes comment text and removes comment icon.
myBlock.setCommentText(null);
Kemampuan untuk menangani komentar secara terprogram tidak terpengaruh oleh status blok (seperti apakah blok dapat diedit atau diciutkan) atau setelan opsi konfigurasi comments
.