Introdução aos Comentários em PHP
A própria palavra comentário expressa seu significado como comentar algo. Se comentarmos alguma coisa no arquivo de programa PHP, ele não será compilado com o código. O compilador ou o intérprete simplesmente ignorará isso. Existem várias maneiras de comentar sobre qualquer coisa na linguagem de programação PHP. O PHP também possui uma única linha e várias opções de comentários. Além disso, no comentário de linha única, podemos usar o / ou # conforme nossa conveniência. Sempre devemos escrever o idioma apropriado no comentário para que qualquer pessoa que esteja revisando esse código possa ler e entender esse comentário.
Sintaxe
Novamente, podemos usar o comentário das maneiras mencionadas abaixo no PHP.
Comentário de linha única:
// This is a single-line comment
# This is a single-line comment
/*
This is a multiple line comment – line no – 1
This is a multiple line comment – line no – 2
… and so on …
*/
# this is the single-line comment
; this is a PHP.INI style commenting
Como os Comentários em PHP funcionam?
No momento em que escrevermos o comentário no código, ficará mais claro comparativamente ao código real. Se tivermos escrito código e o comentário no mesmo arquivo, nesse caso, o comentário não será executado durante a execução do arquivo PHP. Então, vamos ver o mesmo com um exemplo.
echo "This is my first PHP Program";
// this is the first program
?>
Isso fornecerá apenas 'Este é o meu primeiro programa PHP' como uma saída, não a parte do comentário.
Por que devemos usar comentários?
Devemos usar o comentário entre o código do programa PHP para garantir que tenhamos comentários de ajuda suficientes para que se possa ler e entender o código com facilidade. No comentário, também podemos escrever com o objetivo de escrever o segmento do código, alterar a data, data de modificação, modificação por etc. É altamente recomendável que um desenvolvedor use o comentário no código de programação para que as coisas possam ser entendidas. facilmente com pouco ou nenhum esforço, sempre que necessário.
Exemplos
Agora, é hora de ver um exemplo rápido e verificar o comportamento do comentário no programa.
Exemplo 1
<_?phpecho "This is my first PHP Program";
// this is the first program
?>
Resultado
Exemplo 2
Comentário de linha única no programa
Código:
<_?phpecho date_default_timezone_get(); //to get the timezone
echo "
"; //line brea;
date_default_timezone_set('Asia/Kolkata'); // setting the timezone to Asia/Kolkata
echo date_default_timezone_get(); //to get the timezone
?>
Resultado
Exemplo 3
Comentário multilinhas no programa
Código:
<_?php/*
This is a function that will take time in minutes and will return that in hours and minutes
We use will this function further to test with some examples.
*/
function hoursandmins($minutes, $format = '%01d Hours, %02d Minutes')
(
if ($minutes < 1) (
return;
)else if($minutes<10)(
if($minutes==1)(
return '0'.$minutes.' Minute';
)
return '0'.$minutes.' Minutes';
)else if($minutes<50)(
return $minutes.' Minutes';
)
$hours = floor($minutes / 60);
$minutes = ($minutes % 60);
$format = "";
if($hours>0)(
if($hours>1)(
$format .= '%01d Hours';
)else(
$format .= '%01d Hour';
)
)
if($hours>0 && $minutes>0)(
$format .= ', ';
)
if($minutes>0)(
if($minutes>1)(
$format .= ' %02d Minutes';
)else(
$format .= ' %01d Minute';
)
)
return sprintf($format, $hours, $minutes);
)
// time to check the time in descriptive form
echo hoursandmins(20);
echo "
";
echo hoursandmins(120);
?>
Resultado
Qualquer comentário escrito antes de qualquer função sobre essa função é conhecido como documentação da função. Portanto, nos cenários apresentados, podemos dizer esse comentário como um documento de função. É muito bom usar o comentário assim. Para tornar o programa PHP mais robusto, temos vários padrões PHP que dizem que não devemos usar o comentário dentro da função, pois podemos fazer o mesmo na documentação da função.
Exemplo 4
Comentário misto
Em um arquivo de programa PHP, podemos combinar PHP e HTML. Considerando isso, usaremos o método de comentários HTML para comentar a parte HTML sempre que necessário, e os comentários do PHP podem ser usados para o código relacionado ao PHP conforme os requisitos de negócios. Podemos usar qualquer tipo de comentários PHP e HTML em um arquivo PHP-HTML.
Código:
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
Resultado
Exemplo 5
Comentário de linha única usando #
Podemos usar a única linha comentando usando o # também. Vamos ver um exemplo do código para o mesmo. Podemos ver que essa linha de comentários não é tão popular. Muito poucos desenvolvedores usam esse tipo de comentário. Isso é realmente recomendado para comentar a documentação da função ou a documentação no nível do arquivo.
Código:
<_?php# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>
Resultado
Conclusão - Comentários em PHP
Um comentário é realmente uma chamada de tempo no código. Podemos usar o comentário em nosso arquivo de programa PHP. Isso nos ajudará a tornar o código mais compreensível. Devemos usar o comentário antes de iniciar uma função ou a classe, pois a maioria das linguagens de programação possui seu próprio padrão de código. Geralmente, o comentário antes de qualquer função ou classe chamava a documentação dessa função ou da classe.
Artigos recomendados
Este é um guia para comentários em PHP. Aqui discutimos a introdução, Como funciona, por que devemos usar comentários junto com Exemplos e resultados. Você também pode consultar nossos outros artigos sugeridos para saber mais:
- Palavras-chave Python
- Matriz de impressão em Java
- O que é XPath?
- Herança em PHP