Consejos útiles

Lección 6

Pin
Send
Share
Send
Send


Los comentarios en PHP durante la ejecución del script son ignorados por el preprocesador y son necesarios solo para las personas. Los desarrolladores a menudo descuidan los comentarios de código.

Los programadores opinan que recordarán cómo funciona el código y después de seis meses y un año después. Otra razón para no dejar comentarios es la creencia de que el código está tan bien escrito que es claro y sin explicación. Pero debe recordar que puede ser necesario continuar manteniendo los scripts PHP creados durante mucho tiempo después de la escritura.

Una razón igualmente importante para comentar sobre el código es asegurarse de que los seguidores admitan o agreguen funcionalidad a su creación. También se beneficiarán al leer los comentarios que quedan.

PHP proporciona dos formas de comentar: una para comentarios de una sola línea y la segunda para comentarios de varias líneas. PHP toma la sintaxis de los comentarios de C, C ++ y Java. Entonces, si está familiarizado con ellos, entonces no habrá sorpresas para usted.

Comentarios de línea única de PHP

Antes de los comentarios que están en la misma línea, se colocan dos barras (//) en PHP.

El siguiente ejemplo contiene un comentario PHP de una sola línea en el código:

Un comentario de una sola línea puede estar en una línea separada o agregarse al final de una línea de código:

En el ejemplo anterior, el preprocesador PHP ejecutará la función echo e ignorará todo después de //.

Los comentarios de una sola línea también se usan para eliminar temporalmente líneas de código de un hilo de ejecución. Por ejemplo, el siguiente cambio en el ejemplo anterior hará que PHP ignore todo el comando echo en tiempo de ejecución:

Comentarios PHP de varias líneas

Los comentarios de varias líneas para el sitio PHP están envueltos con delimitadores / * y * /. El símbolo / * indica el comienzo de un bloque de comentarios y * / indica su finalización. El siguiente ejemplo demuestra el uso de comentarios de varias líneas:

Los comentarios de varias líneas son útiles cuando las notas que desea insertar en el código ocupan más de una línea. La capacidad de marcar bloques de líneas como comentarios evita el uso de un solo comentario de línea al comienzo de cada línea.

Otro uso útil de los comentarios de varias líneas es deshabilitar temporalmente los bloques de código PHP. Una práctica común es escribir un script PHP y pensar si puede reescribirlo para que sea más eficiente. En esta situación, puede comentar el código antiguo para que ya no se ejecute y escribir uno nuevo. Si resulta que el nuevo código es peor que el original, puede eliminar comentarios y nuevo código en PHP. Y luego descomente el viejo para devolverlo al hilo de ejecución.

Los comentarios de una o varias líneas se pueden agregar fácilmente al código PHP mediante una sintaxis especial. Intenta desarrollar el hábito de comentar tu código.

Ahora que hemos aprendido algunos conceptos básicos de PHP, es hora de aprender los conceptos básicos de este lenguaje de programación, comenzando con la introducción de variables PHP.

Esta publicación es una traducción del artículo "Comentario del código PHP" preparado por el equipo amigable del proyecto Internet technology.ru

Comentario sintaxis php: comentario de una sola línea

Mientras que en html solo hay un tipo de comentario, en PHP hay hasta dos tipos. El primer tipo que discutiremos es un comentario de una línea. Es decir, un comentario que le dice al intérprete que ignore todo lo que sucede en esta línea a la derecha de los comentarios. Para usar este comentario, use los caracteres "//" o "#" y el intérprete de PHP ignorará todo el texto de la derecha.

Tenga en cuenta que varios de nuestros comandos de eco no se procesaron porque los comentamos usando caracteres especiales de comentario. Este tipo de comentario a menudo se usa para escribir rápidamente código complejo y confuso o para eliminar temporalmente una línea de código PHP (para la depuración).

Comentario sintaxis php: comentario de varias líneas

Al igual que los comentarios HTML, los comentarios de varias líneas en PHP se pueden usar para comentar grandes bloques de código o para escribir comentarios en varias líneas. Los comentarios de varias líneas en PHP comienzan con "/ *" y terminan con "* /". Cualquier cosa entre estos personajes será ignorada.

¡Comentar el código es bueno!

Comentar es algo que puedo recomendar a todos los programadores PHP novatos. Comenta tu código! Muchas personas escriben código complejo en PHP y son demasiado flojos para escribir buenos comentarios o piensan que los comentarios no son necesarios. Sin embargo, ¿realmente cree que puede recordar exactamente lo que pensó cuando escribió este código hace un año o más?

¡Escriba comentarios hoy y se lo agradecerá en el futuro por eso! :) Poner dos barras y garabatear algunas palabras sobre el código no será difícil, ¡pero será muy útil cuando vuelvas a él después de un tiempo!

Comentarios:

  1. Misha - 03/04/2013 12:47

Sí, comentar sobre el código es muy importante, ¡estoy absolutamente de acuerdo con el autor!

Sergey - 25/03/2013 9:46 p.m.

Entendí todo cómo hacerlo, pero incluso el texto en el archivo index.pxp no se muestra para mí, nada más, en la misma carpeta, el texto en el archivo menu.pxp

Sergey, honestamente no entendí nada) ¿Qué no se muestra y dónde? Los comentarios no deben mostrarse; solo son visibles en el código fuente de la página.

Stas - 28/02/2017 13:55

Aún más fácil es poner una secuencia de comandos de comentarios ya preparados en un sitio como disqus

Vitaly - 23/05/2017 13:30

Stas, gritando de ti)) ¿de dónde viene el disco? No se trata de comentar en el sitio, sino de comentar piezas, bloques o líneas de código en PHP, para que luego sea más fácil para usted comprender lo que escribió, y si alguien más lee el código, también será más fácil))

Pin
Send
Share
Send
Send