Lição 7: Comentando seus scripts
Como você já deve ter concluído, um script PHP pode se tornar bastante confuso de entender. Nesta lição falaremos sobre comentários, sua importância e a maneira correta de inserí-los nos seus scripts.
Por que é importante comentar os scripts?
Quando codificamos, estamos escrevendo comandos para um servidor/computador usando uma linguagem estritamente formal que pode não refletir claramente o que você estava pensando quando criou o script.
Ora, isso pode criar dificuldades para terceiros (ou mesmo para você) quando se tratar de entender como o script foi estruturado e como consequência tornar extremamente árdua a tarefa de identificação e correção de erros.
Comentários são usados para se escrever pequenos textos explanatórios no script. O servidor ignora qualquer comentário no script e eles não afetam ou interferem com a funcionalidade do script.
No mundo dos negócios é comum as Companhias exigirem que os scripts e programas sejam comentados, pois é considerado um alto risco aceitar um sistema no qual a identificação e correção de erros se torna uma tarefa difícil pela falta de comentários.
Como inserir comentários?
É fácil inserir um comentário. Você simplesmente começa um texto de comentário escrevendo duas barras: "//".
Observe um exemplo mostrado na lição 5 no qual inserimos comentários:
<html> <head> <title>Loops</title> </head> <body> <?php // Escreve código de cores usando três loops // Vermelho pode estar entre 0 e 255 for ($intRed=0; $intRed<=255; $intRed=$intRed+30) { // Verde pode estar entre 0 e 255 for ($intGreen=0; $ intGreen<=255; $intGreen=$intGreen+30) { // Azul pode estar entre 0 e 255 for ($ intBlue=0; $intBlue<=255; $intBlue=$intBlue+30) { // O código de cores tem o formato rgb(vermelho,verde,azul) $strColor = "rgb(" . $intRed . "," . $intGreen . "," . $intBlue . ")" // Aqui escrevemos o código da cor echo "<span style='color:" . $strColor . "'> " . $strColor . " </span>"; // Fecha os loops } } } ?>
Para clareza do exemplo incluímos muitos comentários extras mostrando inequivocamente que os comentários auxiliam, e muito, a tarefa de debugar o script.
Então! Não se esqueça de comentar seus scripts.