Iremos usar um sistema muito interessante para poder nos guiar enquanto programamos. Comentários é um dos princípios de qualquer programadeiro que não quer criar algo e esquecer no dia seguinte.
Os comentários não são interpretados quando o código está sendo lido, então você pode usar e abusar dos mesmos pra documentar tudo que você achar necessário. Observe que nem sempre comentar códigos é bom, mas isso é assunto pra outro momento.
Existem duas formas de comentar no PHP, vamos conhecer as duas e entender quando usar cada uma delas.
Os comentários de linha única são iniciados com duas barras " // " no nosso querido PHP. Veja o exemplo abaixo:
<?php
// Este é um comentário muito foda q vai explicar tudo abaixo
// Mentira nem vai nada não
echo "He4rtDevs <3";
// Será que isso vai ser interpretado?
// To com fomeVocê pode executar o exemplo acima com o seguinte comando:
danielhe4rt@he4rt:~/dev/he4rt/php4noobs/3-Basico/exemplos$ php comentarios1.php
He4rtDevs <3Como podemos observar, não foi mostrado nada fora do esperado. Os comentários são totalmente anulados na hora de qualquer tipo de processamento e só serve de fato para leitura do desenvolvedor.
Para comentar múltiplas linhas, é usado um padrão um pouco diferente do que é acostumado.
- Inicia a linha com /**
- Para cada nova linha é inserido um novo asterisco *
- Para fechar o comentário é inserido */
Veja o exemplo abaixo:
<?php
/**
* Script para visualização de comentarios
* e mostrar o nome do melhor grupo de devs do mundo
*
* @author danielhe4rt - [email protected] // Opcional
* @return void // Opcional
*/
echo "He4rtDevs <3";Podemos ver o resultado novamente na execução abaixo onde não é lido nenhum tipo de comentário.
danielhe4rt@he4rt:~/dev/he4rt/php4noobs/3-Basico/exemplos$ php comentarios2.php
He4rtDevs <3Ir para: 3.3 Tipos de dados