Uso de métodos

Owned by Leandro Miozzo Bonato
Last updated: Jan 10, 2024
2 min read

O uso de métodos (funções e procedimentos) no VsScripter deve ser implementado sempre que possível, pois isso evita redundância de código e a alta facilidade na manutenção de todo o script. Para isso siga alguns exemplos abaixo:

 

1 - Nomes Significativos

  • Escolha nomes de métodos que descrevam claramente o que eles fazem.

  • Evite nomes ambíguos ou muito genéricos. Um método deve expressar sua função de maneira compreensível.

  • Escolha um nome do que realmente o método faz, se este método tem mais de uma responsabilidade, então considere refatorar este método e dividi-lo em dois (ou até mesmo em mais de dois).

// Não tão bom procedure M1; // Melhor procedure CalcularTotal;

 

2 - Métodos Curtos

  • Mantenha os métodos curtos e focados em uma única responsabilidade.

  • Métodos curtos são mais fáceis de entender e testar.

Crie uma regra para que um método tenha no máximo 20 linhas de código. Se passar disso, deve ser refatorado ou repensado.

// Não tão bom procedure ProcessarPedido; // Melhor procedure ValidarPedido; procedure AtualizarEstoque;

 

3 - Evitar Efeito Colateral

  • Evite que os métodos alterem o estado de variáveis ou objetos fora de seu escopo.

  • Os métodos devem ser previsíveis e não causar efeitos colaterais inesperados.

// Não tão bom procedure AtualizarCliente(var cliente: TCliente); // Melhor function CriarClienteAtualizado(const cliente: TCliente): TCliente;

 

4 - Comentários Significativos:

  • Adicione comentários apenas quando necessário, explicando a razão de uma escolha ou fornecendo informações adicionais.

  • O código deve ser autoexplicativo na medida do possível.

  • Seja breve nos comentários e não se delongue muito neles.

 

5- Tratamento de Erros Adequado

  • Lide com erros de maneira apropriada dentro dos métodos.

  • Não ignore exceções; em vez disso, trate-as de maneira significativa.

 

6 - Não faça implementações dentro dos eventos.

  • Não faça implementações dentro dos eventos.

  • Crie um método específico e chame-o dentro do evento para executar a rotina necessária

 

Use quantos métodos forem necessários.