Contenido

• Pasos
• Consejos

Un comentario es un tipo de anotación que se puede utilizar para aclarar el propósito de un fragmento de código. En PHP, hay varias opciones de comentarios disponibles, dos de las cuales están influenciadas por lenguajes populares más antiguos, comentando solo una línea. Otro te permite comentar varias líneas al mismo tiempo, como en el lenguaje C. Puedes usar comentarios para evitar que se ejecuten fragmentos de código o incluso para crear documentación del programa.

Pasos

Parte 1 de 2: Tipos de comentarios

1. 

   Utilice comentarios de una sola línea para hacer notas breves. En este caso, el área de comentarios terminará al final de la línea o al final del bloque de código. Estos comentarios solo funcionan dentro de etiquetas (marcado) PHP, por lo que solo se leerán si se colocan dentro de HTML.

2. 

   
   
   Utilice comentarios de varias líneas para comentar fragmentos de código más grandes o para realizar pruebas. Este tipo de comentario es útil para escribir una explicación larga o para evitar que se ejecute un segmento de código. Consulte la sección "Aplicaciones" a continuación para obtener algunos consejos sobre este tipo de comentario.

Parte 2 de 2: Aplicaciones

1. 

   Utilice los comentarios para dejar sugerencias sobre cómo funciona el código. No es necesario hacer esto para todas las líneas, ya que un buen código debería ser fácil de entender para otros programadores, pero los comentarios son muy útiles para explicar funciones diferentes o difíciles de entender.

2. 

   
   
   Deje comentarios para que pueda recordar lo que ha hecho en el pasado. No importa si está trabajando en un proyecto propio, los comentarios pueden ayudarlo a recordar dónde lo dejó la última vez. Deje comentarios sobre fragmentos de código que no funcionan o que aún no están terminados.

3. 

   Comenta los códigos que quieras compartir. Si planea trabajar junto con otros o planea hacer un proyecto de código abierto, los comentarios serán muy útiles para ayudar a otros a comprender cómo funciona el código y dónde hacer mejoras.

4. 

   
   
   Utilice comentarios para evitar que se ejecuten bloques específicos de código. Hacerlo es muy útil para realizar pruebas en las que necesita que no se ejecute algún código. Todo lo que esté dentro de las etiquetas se ignorará cuando se cargue la página.

5. 

   Tenga cuidado al comentar sobre grandes bloques de código. La función de comentario terminará tan pronto como se encuentre una etiqueta final, por lo que si ya hay un comentario de varias líneas dentro del código que desea comentar, el nuevo comentario terminará en el mismo lugar que el primero.

6. 

   Utilice comentarios para crear documentación sencilla. Puede utilizar un formato creativo para permitir que la documentación se realice directamente en el código. Hacerlo puede resultar útil para proyectos de código abierto.

Consejos

• Los comentarios HTML y PHP son diferentes. Por lo tanto, cuando utilice scripts (mezcla HTML con PHP), tenga cuidado de no intercambiar comentarios.
• En el siguiente código, por ejemplo, hay un comentario HTML, pero el código PHP aún se ejecutará. Colocar un comentario HTML dentro de las etiquetas PHP provocará errores.
  • echo ’olá’;->