Bem-vindos de volta, pessoal. Hoje vamos falar sobre comentários no código, explicando como se faz e para que servem. Se estão prontos, vamos nessa! Se perderam o início, aqui vai o link para os outros posts: Parte 1 - Parte 2 - Parte 3
Hoje vamos abordar um assunto que é um pouco controverso entre os programadores: comentários no código. Alguns acham que eles não influenciam em nada; outros defendem que além de ser uma perda de tempo, introduz uma chance de erro. Vou discutir o porquê abaixo.
Os comentários no código nada mais são que linhas dentro do código que não serão interpretadas pelo computador, ou seja, serão ignoradas. O que você pode colocar nessas linhas? Qualquer coisa! Mas a realidade é que os programadores usam-no para documentar partes do código que podem ser confusas ou de difícil compreensão. Como falei, alguns programadores não gostam de comentários no código por um motivo principal: se você atualizar o código que possui o comentário mas não atualizar o comentário você introduz erros no programas. Como assim? Pense no seguinte:
Você é responsável pelo conserto de 10 computadores de uma seção, e precisa instalar o 7-Zip em todos eles. Você cria o script do último post e pronto! Você comenta o código como "Instala o 7-Zip Automaticamente" e continua consertando os computadores. Mas aí você percebe que precisa instalar o BrOffice (suíte de aplicativos para escritório livre e gratuito, alternativa ao Microsoft Office - Word, Excel e PowerPoint) em todos eles também! Você usa os conhecimentos adquiridos aqui e faz um instalador automático para ele também. No entanto, você precisa que os dois programas sejam instalados, então você decide colocar o código de instalação do BrOffice no mesmo arquivo do 7-Zip. Agora o mesmo script instala os dois softwares, mas se uma pessoa que não conhece AutoIt ler o código, vai achar que ele só instala o 7-Zip. Por que? Porque não atualizamos o comentário! E quanto mais comentários pior, pois é necessário atualizar todos os comentários referentes à alteração que fizermos.
Mas como estamos iniciando e já temos uma quantidade de linhas e comandos, vamos usar um pouco de comentários para esclarecer um pouco o que nosso código faz. Conforme formos avançando, vou dando dicas de quando e porquê comentar o código. Primeira coisa que precisamos saber: Existem duas maneiras de comentar um código.
A primeira é usar as diretivas #cs e #ce dessa maneira:
#cs
Isto é um comentário
#ce
Tudo o que for colocado entre #cs e #ce será ignorado pelo computador. Esse tipo de comentário é usado no início do script, para informar para quê ele serve e como deve ser usado, e pode ter mais de uma linha. O outro tipo de comentário é mais simples, é só colocar um ponto-e-vírgula ; ... Veja como ficaria:
;Isto é um comentário
Viu? Simples, mas funciona de uma maneira diferente do comentário anterior. O ponto-e-vírgula faz o computador ignorar tudo o que vem depois dele ... mas não suporta múltiplas linhas. Então, se quisermos escrever duas linhas de comentário com o ponto-e-vírgula, temos que fazer assim:
;Comentário 1
;Comentário 2
Mas a vantagem é que podemos comentar uma linha que já possua algum código funcionando. Veja o exemplo abaixo (se quiser teste no seu computador):
MsgBox(0, "Teste", "Teste de Comentário") ;Exibe uma caixa de diálogo
O código acima ainda mostra uma caixa de diálogo, e o comentário está na mesma linha que o comando.
Esse tipo de comentário é usado para explicar alguma lógica não tão simples. Podemos usar o ponto-e-vírgula para outra coisa também: ignorar comandos enquanto testamos. Vamos dizer que nós fizemos um script mas algo não está funcionando como gostaríamos. O que fazer? Bom, podemos começar comentando todas as partes do código que achamos que estão com problema, e vamos descomentando uma por uma até achar o problema (veja que uso problema ao invés de erro, pois erros são capturados pelo SciTE e podemos achá-los facilmente).
Como demonstração vou comentar o código de instalação automática do 7-Zip. Veja abaixo:
#RequireAdmin ; Executa o Instalador Run("7Zip.exe") ; Espera o Instalador abrir WinWaitActive("7-Zip") ; "Aperta" o Install Send("!i") ; Espera aparecer a solicitação de Reinicialização WinWaitActive("7-Zip", "You must restart"); "Aperta" o NãoSend("!n") ; Espera terminar de Instalar WinWaitActive("7-Zip", "is installed") ; "Aperta" o Close Send("!c")
Se liguem que no próximo post, vamos deixar o instalador um pouquinho mais inteligente! Abraços!
Nenhum comentário:
Postar um comentário