Início e fim das rotinas

Todos os tipos de rotina tem início e fim em suas declarações. De fácil identificação no início, começando com FORM, MODULE, CLASS, entre outros... E de fácil identificação no fim, terminando com ENDFORM, ENDMODULE, ENDCLASS, entre outros...

Simplesmente saber disso já basta??? Na verdade sim rsrsrs. Mas existe algo que facilita muito o dia-a-dia e as manutenções.


A manutenção de programas desconhecidos, complexos ou sem documentação é uma das maiores dificuldades do dia-a-dia. Em programas ou includes com muitas rotinas, muitas vezes se torna difícil entender onde terminam cada uma dessas rotinas. E é nessas situações que se faz necessário a identificação de início e fim das rotinas.




Pode parecer uma perfumaria sem tamanho, mas acredite, é algo que ajuda muito (muito mesmo) quem não conhece o programa.

Imagine-se numa situação onde seja necessário olhar um programa, para entender o funcionamento técnico, fazer alguma manutenção, ou ainda para fazer documentação. E então quando você vê um ENDFORM fica na dúvida se ele está fechando o mesmo FORM que você já estava olhando ou se você não percebeu que já era outro FORM. Aí você é obrigado a rolar a página de volta para conferir e ter certeza.

Identificando o início e fim das rotinas é possível ter essa visão de forma mais prática. Alguns podem questionar e dizer: "... mas dependendo do editor, o próprio sistema já destaca, na barra inferior de status, o nome da rotina visualizada...". Concordo, mas por mais incrível que pareça conheço excelentes profissionais que preferem os editores antigos, que não possuem as facilidades dos editores mais novos. E tem também uma questão de facilidade, pois é muito mais prático ler no próprio código.

Uma coisa simples de se fazer, e que vai consumir praticamente nada do tempo de cada um, é colocar um cabeçalho comentado nas linhas antes do começo da rotina com uma breve explicação do que é feito dentro da rotina e também os parâmetros que podem haver ao chamá-las. Eu, particularmente, não tenho o costume de colocar essa explicação e nem os parâmetros. O que faço é simplesmente colocar uma pequeno cabeçalho com o nome da rotina. E, o que pra mim é o mais importante, colocar uma identificação comentada ao lado do final da rotina com o nome da respectiva rotina. Entenda sobre texto comentados na postagem Comentários nos códigos.

Seguem exemplos:

*&----------------------------------------------------------------*
*&      FORM  zf_rotina_form
*&----------------------------------------------------------------*
FORM zf_rotina_form.

ENDFORM. "zf_rotina_form

*&----------------------------------------------------------------*
*&      FORM  zf_rotina_module
*&----------------------------------------------------------------*
MODULE zm_rotina_module OUTPUT.

ENDMODULE. "zm_rotina_module OUTPUT

Lembrando que estou longe de ser o dono da razão, essas são apenas pequenas sugestões que podem melhorar um pouquinho nosso dia-a-dia. Repare como as rotinas ficam melhor separadas e como fica mais fácil identificar o final correspondente de cada rotina. Mostrei exemplos apenas para FORM e MODULE, mas o modelo pode ser aplicado em qualquer tipo de rotina.


Não custa nada fazer algo que pode ajudar alguém.
Um grande abraço e até a próxima.