Comentarios en PHP

Realizar comentarios dentro del código PHP es una muy simple pero eficaz costumbre, que consiste en ir escribiendo dentro de cada bloque de código aclaraciones que no sean de utilidad cuando, varios días, semanas o meses después, volvamos a leer el código para hacerle alguna modificación.

Recordemos que estos comentarios no llegan al código fuente del navegador, por lo que los usuarios de nuestros sitios no los pueden ver, ya que son para nuestro uso personal y el de otros programadores que tengan acceso a nuestro código.

El objetivo de envolver algo entre comentarios es lograr que el software intérprete de PHP no intente ejecutar las palabras que escribamos, sino que las ignore, y prosiga luego de finalizado el comentario.

Los comentarios en PHP, al igual que en cualquier otro lenguaje son muy importantes, ya que ayudan a otras personas a comprender lo que hacemos con nuestras líneas de código, al igual que también nos ayudará a nosotros cuando programemos una página web, y pasado un tiempo, queramos hacer modificaciones.

Los comentarios, nos ayudarán a comprender de una forma sencilla cualquier parte del código.

Los comentarios que emplearemos pueden ser de cualquier tipo. Cada programador sigue unas pautas a la hora de realizar sus códigos, y los hay que no utilizan los comentarios.

Para las personas que conozcan otros entornos de programación, como puede ser C o C ++, no les resultará nada complicado el aprender a hacer comentarios en PHP, ya que se hace exactamente igual que en esos mismos lenguajes de programación.

En primer lugar, podemos utilizar //, pero sólo nos servirá para hacer comentarios en una sola línea; si queremos utilizar varias líneas para realizar nuestros comentarios, utilizaremos para comenzar el comentario:

/*, y para terminar */.

PHP permite escribir comentarios de una o varias líneas:

<?php
$variable=”valor”; //comentario de una línea
$cifra = 123; #otro comentario de una línea
echo $variable; /*comentario
Multi
Línea
*/
?>

Un uso práctico es aclarar cosas que sea útil recordar más adelante, al revisar este código:

<?php
$clave = “xyz345”; //recordar avisar al gerente si la cambiamos
$tolerancia =3; #es la cantidad de reintentos de ingreso tolerados con una contraseña equivocada
echo $clave; /*recordar que si mostramos esto,
previamente deberíamos informar al usuario,
para que no lo exponga a la vista de otros.
*/
?>

EJEMPLO

<?
phpinfo(); //con este ejemplo vemos la configuración del intérprete
//de PHP, podemos comprobar qué parámetros tenemos activados o
//desactivados y, si se dispone de algún conocimiento, podremos
//modificar alguno de estos parámetros al igual que hemos hecho
//anteriormente en los ficheros de configuración.
//Como podemos comprobar, esta forma de incluir comentarios en este
//ejemplo no es la más correcta, ya que utilizamos varias líneas y es
//menos eficaz al tener que escribirlo ocupando un mayor espacio.
?>

Lo más correcto, para realizar el ejemplo anterior sería realizarlo de este otro modo, ya que evitamos el tener que poner // cada vez que modifiquemos este comentario, y utilizando /* */ podemos modificar el texto del comentario sin tener que estar pendientes de agregar de nuevo el inicio del comentario con //.

<?
phpinfo();
/*Con este ejemplo vemos la configuración del intérprete de PHP, podemos comprobar qué parámetros tenemos activados o desactivados y, si se dispone de algún conocimiento, podremos modificar alguno de estos parámetros al igual que hemos hecho anteriormente en los ficheros de configuración.
Como podemos comprobar, esta forma de incluir comentarios en este ejemplo es más correcta, ya que utilizar varias líneas es más eficaz que el ejemplo anterior */
?>

Otro uso muy práctico de los comentarios es “desactivar” renglones de código que queremos que no se ejecuten, pero que no tenemos la intención de borrarlos, sino que sólo queremos ejecutar el archivo sin que se ejecuten las líneas del código comentadas. Comentamos partes del código, y es como si no existieran. Esto nos ayuda en la detección de errores, si comentamos alguna línea cercana a la zona en que está produciéndose un error, para evitar su ejecución y ayudarnos a detectar qué es lo que está produciendo.