Nexto XF – #10 Inserindo comentários nos símbolos e redes

O objetivo deste tutorial é demonstrar a inserção de comentários nos símbolos e redes de um projeto do MasterTool X.

Componentes

Equipamentos: 1 computador/notebook.

Software:  MasterTool X

Seções do Tutorial

1. ARQUITETURA
2. DESENVOLVIMENTO

1. ARQUITETURA

Será necessário a utilização de um computador/notebook para utilizar o Mastertool X.

Figura 1. Computador executando o Mastertool X

2. DESENVOLVIMENTO

Em projetos de automação, o uso de comentários é fundamental para facilitar o entendimento da lógica, a manutenção do sistema e o trabalho de outros programadores que venham a acessar o código futuramente. No entanto, o excesso de informações visuais pode deixar a lógica poluída e difícil de interpretar, tornando importante habilitar apenas os comentários realmente essenciais.

Para habilitar a visualização dos comentários das variáveis na lógica Ladder, siga os passos abaixo:

1. Acesse o menu Ferramentas.
2. Clique em Opções.
3. Selecione Editores FBD, LD e IL.
4. Na aba Geral, marque a opção ”Exibir comentário do símbolo”.
5. Clique em OK.

Figura 2. Habilitando a visibilidade dos comentários da lógica

Após essa configuração, o comentário (Description) associado à variável passará a ser exibido diretamente na lógica, facilitando o entendimento e a manutenção do programa.

Figura 3. Lógica com a visualização dos comentários habilitada

Observação sobre outras opções de visualização

O MasterTool IEC XE oferece outras opções de comentários e visualizações, como:

• Comentário da linha (rede)
• Visualização do endereço físico ao qual a variável está relacionada

Essas opções podem ser úteis em situações específicas, porém não são essenciais no dia a dia. Recomenda-se que o usuário habilite apenas o que for realmente necessário, evitando excesso de informações e mantendo a lógica mais limpa e legível.

Inserindo comentários em variáveis locais

Além dos comentários via Description, é possível adicionar comentários diretamente na declaração das variáveis locais.

Para isso, basta utilizar // após a declaração da variável e inserir o comentário desejado.

Exemplo:

VAR
    Botao_Liga : BOOL; // Botão de acionamento do sistema
    Motor_ON   : BOOL; // Indica motor ligado
END_VAR

Esses comentários ajudam a documentar a função de cada variável diretamente no código, contribuindo para uma programação mais clara e organizada.

Figura 4. Comentários das variáveis locais