AMP
Tecnología

Cómo añadir comentarios en PHP correctamente

3 ’ lectura

Añadir comentarios en PHP es de lo más fácil, siempre y cuando los pasos a seguir se respeten detalladamente. Ahora bien, aquí tienes la manera adecuada para lograrlo.

Tendrás varias opciones para elegir, las cuales se desprenden de los viejos lenguajes populares, que contaban con dos alternativas para hacer comentarios. Puedes usarlos para evitar que se ejecuten ciertas partes del código o incluso usarlos para crear documentación.

De dicha forma, entenderás mejor la funcionalidad de lo que confiere a los archivos Hosts.

Pasos para añadir comentarios en PHP

  1. En primer lugar, usa comentarios de una sola línea para hacer comentarios breves. El comentario solo durará hasta el final de la línea o el final del bloque de código.

    Estos comentarios solo funcionan entre etiquetas de PHP y se leerán si los colocas en HTML.

  2. Luego, usa comentarios de varias líneas para escribir comentarios largos o probar el código. Lee la sección Usos para ver algunos consejos sobre los distintos usos que tienen los comentarios de varias líneas.
  3. Por consiguiente, utiliza comentarios para dejar notas acerca de cómo funciona el código. No es necesario hacerlo con cada línea de código, ya que un buen código debe ser fácilmente entendible entre los programadores.

    Esto es útil si el código realiza funciones poco habituales o no tan evidentes.

  4. Después, deja comentarios para recordar lo que estabas haciendo. Deposítalos en partes del código que no estén funcionando correctamente o que todavía no hayas terminado.
  5. Posteriormente, agrega comentarios en código que vayas a compartir. Si planeas colaborar con otras personas o tienes la intención de crear código abierto.

    Estos pueden ayudar a los demás a descubrir cómo funciona tu código y cuáles son los mejores lugares para hacer mejoras.

  6. Utiliza comentarios para evitar que se ejecuten bloques de código específicos. Todo lo que se encuentre dentro de las etiquetas de comentarios se ignorará cuando se cargue la página.
  7. Ten cuidado cuando vayas a comentar bloques extensos de código. La función de comentar finalizará al encontrar la primera etiqueta de cierre, o sea que si ya había un comentario de varias líneas dentro del código que comentaste.
  8. Por último, usa los comentarios para crear una pseudodocumentación. Puedes usar un formato creativo de código para crear documentación en tu código y para tu código.

    Esto puede ser útil en proyectos de desarrollo de código abierto.

Ante todo lo que se ha referido, te complementamos con contenido audiovisual de consejos y herramientas. De esa forma, podrás adquirir instrumentación necesaria para afrontar dicha temática:

Otros artículos que podrían interesarte:

Recientes