Adiciona um bloco de comentário na função e no código gerado.

Figura 1 - Bloco Comentário

Compatibilidade

• Bloco cliente: cronapi.organizers.comment()

Retorno

O bloco não possui retorno.

Características do bloco

O bloco Comentário, assim como os blocos de Grupo e Marcador, permite alterar o conteúdo e a cor do bloco tornando mais simples visualizar o comentário adicionado.

Para alterar o conteúdo, ou seja, o texto "Comentário" entre as aspas, basta clicar sobre o ícone de engrenagem do bloco (destaque 1 da Figura 2). Em seguida, a janela Editor de Texto será aberta permitindo a edição do conteúdo do bloco. Após salvar a função, além do novo conteúdo no bloco, também será exibido um comentário no código da função (Figura 3).

Figura 2 - Alterando o conteúdo do bloco

Para modificar a cor do bloco, clique no ícone de paleta de cores (destaque 1 da Figura 2.1) ou no retângulo ao lado. Em seguida, todas as cores disponíveis para o bloco serão exibidas. No exemplo abaixo, selecionamos a tonalidade de cinza mais clara.

Figura 2.1 - Modificando a cor do bloco

Parâmetros

O bloco não possui parâmetros.

Exemplo

Na função abaixo, o bloco Comentário adiciona, à função e ao código correspondente, um comentário contendo o objetivo da função.

Figura 3 - Exemplo de uso do bloco Comentário

O resultado da aplicação do bloco pode ser conferido na aba Código, acessível quando o Modo Avançado está ativado ou ao habilitar a opção Sempre mostrar código fonte na janela de preferências do projeto. Para mais detalhes dessas opções, consulte os tópicos "Opção de Modo Avançado" e "Espaço de Trabalho" da documentação Tour pelo Cronapp. O comentário do bloco da função da Figura 3 foi adicionado entre as linhas 21 e 24 da imagem abaixo (destaque 1).

Figura 3.1 - Aba Código da função