Dentro del apartado «Desarrollo Web en Contorno Servidor«, este es el primer post dedicado al lenguaje PHP. Como primer post cuando comienzas a estudiar un nuevo lenguaje de programación, hay que dedicárselo a como comentar en el código PHP, en este caso.
Es evidente que estos comentarios a pesar de ser sencillos de colocar y utilizar, son treméndamente útiles cuando desarrollas un código complicado e intentas releerlo un tiempo después. Como me han dicho estos últimos días, comentar los códigos que se realizan es una de las tres reglas de las buenas prácticas a la hora de picar código. Estas reglas básicas son;
– Usar reglas nemotécnicas a la hora de definir nombres (para facilitarnos la tarea a la hora de recordarlos).
– Utilizar nombres de variables en inglés (para hacer nuestro código más internacional).
– Y no escatimar a la hora de comentar nuestro código.
Ejercicio Básico 1 PHP Comentarios
El código PHP se puede colocar a lo largo y ancho de una página web y existen tres formas de realizar comentarios en PHP, y estas son;
<?php
// Comentario inicial
echo "Primer tipo de comentarios"; // Comentario tipo C, C++
// Comentario final
?>
<?php
/* Comentario inicial */
echo "Segundo tipo de comentarios"; /* Comentario tipo C, C++ */
/*
Comentario
Final
*/
?>
<?php
# Comentario inicial
echo "Tercer tipo de comentarios"; # Comentario tipo shell
# Comentario Final
?>
El siguiente comentario es un ejemplo de lo que no debe hacerse, ya que no se pueden anidar dos comentarios multilínea.
<?php
echo "Comentario... "
/* Este comentario es usado para comprobar
/* que dos comentarios multilinea anidados
no pueden darse
*/
ya que se llega a un error */
?>