Uso de comentarios en PHP

Uso de comentarios en PHP
Los comentarios se utilizan con cualquier código fuente para explicar la funcionalidad del código correctamente. Cada lenguaje de programación usa una sintaxis particular para agregar un comentario en el código fuente. El comentario no es leído por el intérprete o el compilador del lenguaje de programación. El codificador realmente no necesita agregar comentarios en el código, pero hay dos beneficios de usar un comentario en el código. Un beneficio es hacer que el código sea legible para que otros comprendan el código correctamente, y otro beneficio es ayudar al codificador a recordar la funcionalidad del código después de mucho tiempo cuando el código requiere modificación. La sintaxis de comentarios utilizada en PHP es similar a otros lenguajes de programación estándar como C, C ++, Java, etc. El comentario puede ser una línea única y de múltiples líneas. Cómo se pueden usar comentarios de una sola línea y múltiples en el código PHP en este tutorial.

Comentario de una sola línea

El comentario de una sola línea se puede usar en código PHP utilizando diferentes sintaxis. En este tutorial se muestran dos tipos del comentario de una sola línea del código PHP. Uno es la sintaxis de comentarios de C ++/Java, y otro es la sintaxis de comentarios de Shell. Las dos sintaxis del uso de comentarios de una sola línea en PHP se muestran en esta sección del tutorial.

Ejemplo-1: Comentarios de una sola línea usando C ++/Java Syntax

Los caracteres de doble hash ('//') se utilizan para comentar en una sola línea en el script PHP. En el siguiente script, los cinco comentarios de una sola línea se utilizan para explicar el código. Aquí, se declaran valores de tres cuerdas, y estos se combinan más tarde en otra variable. Se agrega un comentario de una sola línea para cada declaración que el intérprete omite en el momento de la ejecución.

// Establecer el primer valor de cadena
$ str1 = "bienvenido";
// Establecer el segundo valor de cadena
$ str2 = "a";
// Establecer el tercer valor de cadena
$ str3 = "Linuxhint";
// Combinar la cadena con espacio
$ str = $ str1.".$ str2.".$ str3;
// imprime la cadena combinada
eco "

$ str

";
?>

Producción:

La siguiente salida aparecerá después de ejecutar el código. La salida muestra los valores combinados de $ str1, $ str2 y $ str3. Todos los comentarios de una sola línea han sido ignorados por el intérprete.

Ejemplo-2: comentarios de una sola línea usando sintaxis de shell

El símbolo '#' se usa para comentarios de una sola línea en el script de shell que es compatible con PHP. El siguiente script de PHP calcula si el año en curso es un año bisiesto o no. La función personalizada isleap () se usa aquí para calcular si el año en curso es un año bisiesto o no. El comentario de una sola línea se usa en el código para que el script sea más legible para los lectores. Aquí, la función Date () se usa para leer el año en curso que se menciona en el comentario. A continuación, la función mktime () se usa para verificar si el año es un año bisiesto o no. Si el año es un año bisiesto, entonces la función mktime () regresará 1, y el carácter de formato 'l' se usa en la función date () para el año bisiesto. Los comentarios de una sola línea necesarios se utilizan en el script.

#Realice el año en curso desde la fecha del sistema
$ año = fecha ("y");
#Call la función isleap () y pruebe el valor de retorno
If (isleap ($ año))

eco "

El año, $ año es el año bisiesto.

";

demás

eco "

El año, $ año no es un año salto.

";

#Define una función para verificar el año bisiesto
función isleap ($ año)

#Find Out El año es Leap o no
retorno (fecha ('l', mktime (0, 0, 0, 1, 1, $ año)) == 1);

?>

Producción:

La siguiente salida aparecerá después de ejecutar el código. El resultado muestra que el año en curso, 2020, es un año bisiesto, y los comentarios de una sola línea han sido ignorados por el intérprete.

Comentario múltiple

Se utiliza un comentario de varias líneas para agregar un comentario de texto largo. Si el codificador necesita explicar la función del código en detalle para una mejor comprensión, entonces él/ella puede agregar un comentario de múltiples líneas para ese código. El '/*' se usa al inicio del comentario, y '*/' se usa al final del comentario. Este tipo de comentario de múltiples líneas se usa en cualquier lenguaje de programación estándar, como Java, C ++, etc. Un comentario de múltiples líneas se usa principalmente al comienzo de cualquier script para proporcionar información detallada sobre el script, scriptwriter, versión, enlace del código fuente, etc.
Cómo se usan los comentarios de múltiples líneas en PHP se muestra en el siguiente ejemplo:

Ejemplo-3: Comentario de múltiples líneas usando '/ *... */'

En el siguiente script, se utilizan tres comentarios de varias líneas para explicar el código. El primer comentario describe la funcionalidad del script. El segundo comentario explica la función de la función rand (). El tercer comentario explica el propósito de la función ISPRIME (). Se generará un número aleatorio entre 1 a 100 cada vez que se ejecute el script, y la función ISPRIME () descubrirá si el número es primo o no. Si la función devuelve verdadero, entonces el número es primo. De lo contrario, el número no es primo.

/* El siguiente script probará un número particular es
Prime o no Prime utilizando una función personalizada
*/
/* Asignar un número aleatorio entre 1 a 100 usando
función php incorporada rand ()
*/
$ número = rand (1,100);
// verifique que el número sea primo o no primo
if (isprime ($ number))
eco "

$ El número es un número primo.

";
demás
eco "

$ El número no es un número primo.

";
/* La función devolverá 1 si el número aleatorio generado
El número aleatorio es primo y devuelve 0 si el número no es
principal */
función isprime ($ number)
if ($ number == 1)
regresar 0;
por ($ i = 2; $ i

Producción:

La salida del script variará en cada ejecución debido al número aleatorio. La siguiente salida apareció después de ejecutar el código por primera vez, y se cambiará en la próxima ejecución. Si el número aleatorio generado es primo, entonces isPrime () devolverá 1, y si el número aleatorio generado no es primo, entonces isPrime () devolverá 0.

Conclusión

Cada script estándar contiene comentarios para ayudar al lector a comprender el código correctamente. Muchos codificadores nuevos no agregan comentarios en su script que dificulta el código de otros codificadores. Entonces, cuando escribe cualquier script, entonces debe agregar comentarios para cada declaración.