Comentários

Introduzindo Blocos de Código PHP e Comentários

Ao trabalhar com PHP, é essencial entender como definir seções de código que o interpretador PHP deve executar. Alcançamos isso ao envolver nossas instruções PHP dentro de tags especiais. A tag de abertura, ``, marca seu fim. Qualquer coisa encontrada entre estas tags será processada como instruções PHP. Fora destas tags, o texto é tratado como texto padrão e é exibido diretamente.

Por exemplo, se você tiver um arquivo contendo tanto código PHP quanto texto regular, o motor PHP executará o código envolvido nas tags ``, enquanto exibe o texto restante como está. Uma linha em branco no final de um script PHP é uma boa prática para garantir um prompt de terminal limpo após a execução.

Por Que Usar Comentários em PHP?

Como a maioria das linguagens de programação, PHP suporta comentários. Comentários são seções de texto dentro do seu código que o motor PHP ignora completamente durante a execução. Eles servem a uma variedade de propósitos cruciais.

Primariamente, comentários permitem que você adicione notas explicativas diretamente no seu código. Estas notas podem descrever como uma seção particular do código funciona, explicar o raciocínio por trás de uma escolha de design específica, ou servir como um lembrete para tarefas futuras. Isto é inestimável tanto para você quanto para qualquer outra pessoa que possa ler ou manter o seu código.

Além da documentação, comentários são incrivelmente úteis durante o desenvolvimento. Às vezes, você pode querer desabilitar temporariamente um bloco de código sem excluí-lo permanentemente – talvez ao depurar ou experimentar uma abordagem diferente. Simplesmente converter o código em um comentário permite que você habilite ou desabilite rapidamente essa seção conforme necessário. Finalmente, comentários também podem ser usados para armazenar informações para ferramentas automatizadas, como geradores de documentação ou estruturas de teste.

Tipos de Comentários PHP

PHP oferece uma maneira simples e direta para criar comentários.

#### Comentários de Uma Linha

O tipo mais comum de comentário em PHP é o comentário de uma linha. Estes comentários começam com duas barras para frente (//). Tudo na mesma linha depois dessas duas barras é tratado como um comentário e ignorado pelo interpretador PHP. Isso permite que você coloque um comentário ao lado de uma declaração PHP na mesma linha, sem afetar a execução da declaração.

print 2 + 2; // This comment will be ignored and 4 will be printed

Neste exemplo, a declaração print ainda será executada, exibindo o resultado de 2 + 2. O texto seguinte a // é puramente para legibilidade humana.

Entendendo Comentários em PHP

Ao escrever código, é essencial incluir notas para você mesmo e outros desenvolvedores. Estas são chamadas de comentários, e PHP oferece diferentes maneiras de adicioná-los. Um comentário simples de uma linha começa com //. Qualquer coisa que siga este marcador na mesma linha é ignorada pelo interpretador PHP. Por exemplo, print 2 + 2; // Este é um comentário irá gerar 4, mas o próprio comentário não será executado.

Para explicações mais longas ou seções de código que você deseja desativar temporariamente, você pode usar comentários de várias linhas. Estes começam com / e terminam com /. Tudo entre estes marcadores também é ignorado.

/*
This is a multi-line comment.
It can span several lines of code.
This is useful for temporarily disabling a block of code.
*/

Embora você possa ocasionalmente encontrar código mais antigo usando comentários no estilo de shell (começando com #), a sintaxe // é a forma preferida e mais comum para escrever comentários de uma linha no desenvolvimento PHP moderno.