Evite maldições, comente seus códigos.

Faaaala abaper blz?

LNUNES aqui mandando uma ideia simples que aumenta muito, mas muito mesmo a produtividade no dia-a-dia, o bom e velho comentário.

Não tenha medo de usar comentários, use sem dó e piedade.
Não tenha medo de usar comentários, use sem dó e piedade.

Já discuti o tema com uma meia dúzia de profissionais sobre a importância e possíveis padrões, mas o único consenso é que é muito importante! rs

Não há padrão, formato e quantidade de texto corretos, penso que, o melhor comentário é o que explica e auxilia o ABAP a compreender determinado trecho do programa, principalmente quando se trata de um processo complexo.

Deixe-me relatar o caso que inspirou esse tema… a long long time ago…

O SD sentou-se ao meu lado e disse que o resultado de um determinado processamento deveria ser R$10,00 e não R$11,00 como estava ocorrendo. Se tratava do processamento em lote de pedidos para a geração de documentos de venda e o erro ocorria apenas para alguns casos, haviam também relatos de um procedimento que concedia desconto para alguns clientes.

Passei então a buscar nas EXITs do programa SAPMV45A se havia algum tratamento até que, deparei-me com um import de dados da memória.

IMPORT VCXB[] FROM MEMORY ID ‘ZCXB’.

Após muitas horas alguns momentos de analise entendi que essa tabela interna continha dados do mestre de clientes e se o “cara” tivesse um determinado parâmetro ganhava um X de desconto em sua compra. Iniciei então, outra batalha para descobrir aonde estava o export desses dados… enfim, o caso foi solucionado depois de quase um dia de investigação e conjuração de demônios para grudar na cacunda do maledeto que digitou aquela linha de código sem sequer uma única palavra explicando a funcionalidade.

Cara, na moral, porque raios alguém colocaria o nome de uma tabela que contém dados do mestre de clientes de VCXB? O que significa VCXB “Vou Comer XBacon”? Será que ele estava faminto? rssr… Aonde estava o export desses dados? Todas essas são perguntas e horas que podiam ter sido evitadas se o filhote de Mun-Rá tivesse colocado um comentário explicando brevemente o processo, o include do export e/ou o nome do fulano que solicitou aquilo.

Um comentário simples como…

Só isso, é pedir muito?!?!?!?!

Então meu caro, os comentários são muitíssimos importantes e devem ser utilizados com frequência pois podem auxiliar você a lembrar-se por que colocou aquele “WAIT UP TO 2 SECONDS” maroto após um “COMMIT WORK” a 10 anos atrás.

Outro ponto relevante que vale mencionar é que não adianta usar comentários sem sentido, pense um pouco, imagine se o Mun-Rá tivesse colocado o comentário “Importamos dados da memória” ou “Populamos a tabela interna”, seria ainda pior pois eu teria amaldiçoado-o ainda mais.

E para não tomar mais seu tempo, faça o bem e atraia o bem incluindo comentários em suas atividades, se você conseguir se viciar quiçá evitará minhas maldições e ó, xô falá… eu lanço uma maldição pra deixar careca que é fmz hein… te cuida! rs

Ctrl+F3.

LNUNES.

Gostou da leitura? Cadastre-se e receba novidades gratuitamente em seu e-mail!

* Campo obrigatório