Blokowanie komentarzy

Blokowanie komentarzy umożliwia użytkownikom dodawanie komentarzy do bloku. Podobnie jak komentarze w języku programowania tekstowego, nie wpływają one na działanie bloku. Standardowe generatory kodu językowego dodają je do wygenerowanego kodu (w tym kodu wygenerowanego przez niestandardowe bloki).

Blok instrukcji warunkowej z komentarzem

Ikona komentarza

Użytkownicy wpisują komentarze blokowe za pomocą edytora tekstu ikony komentarza.

Domyślnie ikona komentarza nie jest wyświetlana. Możesz go wyświetlić na 2 sposoby:

  • Wywołaj funkcję Block.setCommentText z łańcuchem znaków innym niż null.
  • Użytkownik może wyświetlić komentarz, klikając „Dodaj komentarz” w menu kontekstowym bloku.

Aby usunąć ikonę komentarza:

  • Zadzwoń do Block.setCommentText z użyciem null.
  • Pozwól użytkownikowi usunąć komentarz, klikając „Usuń komentarz” w menu kontekstowym blokady.

Pamiętaj, że opcje „Dodaj komentarz” i „Usuń komentarz” są wyświetlane w menu kontekstowym tylko wtedy, gdy:

  • Blok można edytować.
  • Blok nie jest zwinięty.
  • Opcja konfiguracji comments ma wartość true. Jeśli nie ustawisz tej opcji, jej domyślna wartość to true, jeśli narzędziownik ma kategorie, lub false w innym przypadku.

Blokowanie komentarzy za pomocą kodu

Aby zablokować komentarz:

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

Aby ustawić blokowanie komentarzy:

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

Aby usunąć komentarz blokujący:

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

Możliwość obsługi komentarzy za pomocą kodu nie zależy od stanu bloku (np. od tego, czy można go edytować, czy jest zwinięty) ani od ustawienia opcji konfiguracji comments.