Introducción a los comentarios en PHP
La palabra comentario en sí expresa su significado como comentar algo. Si comentamos algo en el archivo de programa PHP, no se compilará con el código. El compilador o el intérprete simplemente ignorarán esto. Hay varias maneras de comentar cualquier cosa en el lenguaje de programación PHP. PHP tiene una sola línea y múltiples opciones de comentarios de línea también. Además, en el comentario de una sola línea, podemos usar el / o # según nuestra conveniencia. Siempre debemos escribir el lenguaje apropiado en el comentario para que cualquiera que esté revisando ese código pueda leer y comprender ese comentario.
Sintaxis
Nuevamente, podemos usar el comentario de las formas mencionadas a continuación en PHP.
Comentario de línea ú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
¿Cómo funcionan los comentarios en PHP?
En el momento en que escribamos el comentario en el código, será más claro a la vista en comparación con el código real. Si hemos escrito el código y el comentario en el mismo archivo, en este caso, el comentario no se ejecutará mientras se ejecuta ese archivo PHP. Entonces, veamos lo mismo con un ejemplo.
echo "This is my first PHP Program";
// this is the first program
?>
Esto dará solo 'Este es mi primer programa PHP' como salida, no la parte de comentarios.
¿Por qué deberíamos usar comentarios?
Deberíamos usar el comentario entre el código del programa PHP para asegurarnos de tener suficientes comentarios de ayuda para que uno pueda leer y comprender el código fácilmente. En el comentario, también podemos, con el propósito de escribir el segmento del código, cambiar la fecha, la fecha de modificación, la modificación por, etc. fácilmente con poco o ningún esfuerzo cuando sea necesario.
Ejemplos
Ahora, es hora de ver algunos ejemplos rápidos para verificar el comportamiento del comentario en el programa.
Ejemplo 1
<_?phpecho "This is my first PHP Program";
// this is the first program
?>
Salida
Ejemplo # 2
Comentario de línea única en el 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
?>
Salida
Ejemplo # 3
Comentario de varias líneas en el 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);
?>
Salida
Cualquier comentario escrito antes de cualquier función sobre esa función se conoce comúnmente como la documentación de la función. Entonces, en los escenarios dados, podemos decir este comentario como un documento de función. Es realmente bueno usar el comentario así. Para hacer que el programa PHP sea más robusto, tenemos varios estándares PHP que dicen que no debemos usar el comentario dentro de la función, ya que podemos hacer lo mismo en la documentación de la función.
Ejemplo # 4
Comentario mixto
En un archivo de programa PHP, podemos combinar PHP y HTML. Considerando esto, usaremos el método de comentarios HTML para comentar la parte HTML cuando sea necesario, y los comentarios PHP pueden usarse para el código relacionado con PHP según los requisitos comerciales. Podemos usar cualquier tipo de comentarios PHP y comentarios HTML en un archivo 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
?>
Salida
Ejemplo # 5
Comentario de línea única usando #
Podemos usar la línea simple comentando usando el # también. Veamos un ejemplo del código para el mismo. Podemos ver que esta línea de comentarios no es tan popular. Muy pocos desarrolladores usan este tipo de comentarios. Esto se recomienda realmente mientras comenta la documentación de la función o la documentación del nivel de archivo.
Código:
<_?php# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>
Salida
Conclusión - Comentarios en PHP
Un comentario es realmente una llamada de tiempo en el código. Podemos usar el comentario en nuestro archivo de programa PHP. Esto nos ayudará a hacer que el código sea más comprensible. Deberíamos usar el comentario antes de comenzar una función o la clase ya que la mayoría de los lenguajes de programación tienen su propio código estándar. Por lo general, el comentario antes de cualquier función o la clase llama la documentación de esa función o la clase.
Artículos recomendados
Esta es una guía de comentarios en PHP. Aquí discutimos la introducción, Cómo funciona, por qué deberíamos usar comentarios junto con Ejemplos y resultados. También puede consultar nuestros otros artículos sugeridos para obtener más información:
- Palabras clave de Python
- Matriz de impresión en Java
- ¿Qué es XPath?
- Herencia en PHP