PHP - Comentários

Para que serve os comentários em PHP

Recurso muito útil para delimitar partes do código na página que muitas vezes são similares e causam confusão para a gente

Muito útil também para, por exemplo, documentar o que uma função complexa faz porque o programador demoraria um tempo razoável para entender seu funcionamento.

Outro motivo para usar comentários é deixar partes que só deverão ser exibidas no software em versão futura.
Suponha que você esta fazendo uma grande modificação no sistema e deseja que o impacto seja mínimo aos usuários. Primeiramente, você vai fazer os testes no servidor de desenvolvimento, nunca no de produção.
Antes de começar os testes você coloca tudo o que é novo em comentários porque estando comentado o processo não é executado pelo servidor, é simplemente ignorado.
Sendo assim, você vai retirando os comentários das funções mais baixas para as mais altas e testando cada funcionalidade conforme vai retirando os comentários.
Já fiz muitos upgrades em sites que absolutamente ninguém notou nada até abrir a página no dia seguinte e ver a modificação. Graças aos comentários.

Tipos de comentários em PHP

No PHP temos 3 tipos de comentários: 2 tipos de 'uma linha' e um de 'bloco de linhas'.

O caractere # ou os caracteres // definem que o comentário é em uma linha.
   Tudo que estiver a direita desse(s) caractere(s) será ignorado pelo servidor PHP.

Já os caracteres /* e */ são comentários de bloco.
    Tudo que estiver entre o /* e o */ será ignorado, todo o trecho, todas as linhas.

Importante:Nada do que esta em comentários é enviado para o cliente. Fica somente no servidor.


Como é exibido:

Comentário 1 :
Comentário 2 :
Comentário 3 :

Como esperado, nada dos comentários é exibido ou processado.

Código:

        Comentário 1 :<br>
        <?php
            #comentário de uma linha
        ?>
            Comentário 2 :<br>
        <?php
            //comentário de uma linha
        ?>
            Comentário 3 :<br>
        <?php    /* comentário de uma bloco de linhas.
             comentário de uma bloco de linhas.
              comentário de uma bloco de linhas.
               comentário de uma bloco de linhas.
                comentário de uma bloco de linhas.
               */
        ?>

Veja no console de depuração do browser que os comentários sequer são enviados ao cliente, morrem no servidor.

É um excelente meio de documentação mais simples possível, por isso é tido como boa prática mesmo nas empresas que não documentam seus softwares porque o comentário aumenta a produtividade evitando erros e análises desnecessárias.