Cómo comentar en PHP

PDF download Descargar el PDF
Coescrito por Tyrone Showers

PDF download Descargar el PDF

Un comentario es un tipo de anotación que puede utilizarse para aclarar el propósito o la intención de un segmento de código. Cuando usas PHP tienes varias opciones para elegir, las cuales se desprenden de los viejos lenguajes populares, que contaban con dos alternativas para hacer comentarios de una sola línea y también comentarios de varias líneas estilo C. Puedes usar comentarios para evitar que se ejecuten ciertas partes del código o incluso usarlos para crear documentación.

Parte 1
Parte 1 de 2:

Estilos

PDF download Descargar el PDF
  1. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/a\/a8\/2165137-1.jpg\/v4-460px-2165137-1.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/a\/a8\/2165137-1.jpg\/v4-728px-2165137-1.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Si necesitas dejar un comentario breve, puedes usar el código para comentarios de una línea. 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. [1] 
      
 <?php 
 // Esta es la forma estándar (C++) de crear un comentario de una sola línea 
 # También puedes usar el estilo Unix para crear un comentario de una sola línea 
 ?>
  2. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/e\/e1\/2165137-2.jpg\/v4-460px-2165137-2.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/e\/e1\/2165137-2.jpg\/v4-728px-2165137-2.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Los comentarios de varias líneas son útiles para escribir explicaciones largas o para evitar que se procese un segmento de código. Lee la sección "Usos" más abajo para ver algunos consejos sobre los distintos usos que tienen los comentarios de varias líneas. [2] 
      
 <?php 
 /* Esta es la forma en la que puedes darle formato 
 a un comentario de varias líneas. Todo lo que escribas 
 hasta la etiqueta de cierre se incluirá 
 en el comentario. */ 
 /* Algunas personas prefieren incluir 
 * marcadores adicionales al principio 
 * de cada línea. Esto puede ayudar a mejorar la legibilidad 
 * de comentarios extensos, aunque en realidad no es necesario hacerlo. 
 */ 
 ?>
    Anuncio
Parte 2
Parte 2 de 2:

Usos

PDF download Descargar el PDF
  1. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/7\/73\/2165137-3.jpg\/v4-460px-2165137-3.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/7\/73\/2165137-3.jpg\/v4-728px-2165137-3.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    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. [3] 
     // Generar solicitud de CURL 
 $session 
 = 
 curl_init 
 ( 
 $request 
 ); 
 // Decirle a CURL que use HTTP POST 
 curl_setopt 
 ( 
 $session 
 , 
 CURLOPT_POST 
 , 
 true 
 );
  2. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/8\/88\/2165137-4.jpg\/v4-460px-2165137-4.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/8\/88\/2165137-4.jpg\/v4-728px-2165137-4.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Cada vez que estés trabajando en tus propios proyectos, puedes usar comentarios para ayudarte a recordar dónde los dejaste. Deja comentarios en partes del código que no estén funcionando correctamente o que todavía no hayas terminado. 
     // Es necesario revisar la salida antes de continuar 
 echo 
 "¡Hola mundo!" 
 ;
  3. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/6\/62\/2165137-5.jpg\/v4-460px-2165137-5.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/6\/62\/2165137-5.jpg\/v4-728px-2165137-5.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Si planeas colaborar con otras personas o tienes la intención de crear código abierto, los comentarios pueden ayudar a los demás a descubrir cómo funciona tu código y cuáles son los mejores lugares para hacer mejoras. [4] 
     /* ¿Existe alguna forma más eficiente de hacer esto? */ 
 Género: 
 <input type="radio" name="gender" 
 <?php 
 if 
 ( 
 isset 
 ( 
 $gender 
 ) 
 && 
 $gender 
 == 
 "female" 
 ) 
 echo 
 "checked" 
 ; 
 ?> 
  
 value="female">Femenino 
 <input type="radio" name="gender" 
 <?php 
 if 
 ( 
 isset 
 ( 
 $gender 
 ) 
 && 
 $gender 
 == 
 "male" 
 ) 
 echo 
 "checked" 
 ; 
 ?> 
  
 value="male">Masculino
  4. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/f\/f1\/2165137-6.jpg\/v4-460px-2165137-6.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/f\/f1\/2165137-6.jpg\/v4-728px-2165137-6.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Esto es útil si vas a probar algo y necesitas evitar que se ejecute cierta parte del código. Todo lo que se encuentre dentro de las etiquetas de comentarios se ignorará cuando se cargue la página. 
      
 <?php 
 echo 
 "¡/*Hola*/  mundo!" 
 ; 
 /* La palabra "Hola" no se mostrará 
 cuando el código anterior se ejecute */ 
 ?>
  5. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/2\/22\/2165137-7.jpg\/v4-460px-2165137-7.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/2\/22\/2165137-7.jpg\/v4-728px-2165137-7.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    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, el comentario llegará solamente hasta el final del primer comentario anidado. 
      
 <?php 
 /* 
 echo "¡Hola mundo!"; /* Este comentario estropeará tu código */ 
 */ 
 ?> 
  



      
 <?php 
 /* 
 echo "¡Hola mundo!"; // Este comentario funcionará bien 
 */ 
 ?>
  6. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/c\/c5\/2165137-8.jpg\/v4-460px-2165137-8.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/c\/c5\/2165137-8.jpg\/v4-728px-2165137-8.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    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. 
      
 <?php 
 //============= 
 // ENCABEZADO 
 //============= 
 //------------- 
 // Subencabezado 
 //------------- 
 /* Título de la sección */ 
 # Aquí puede ir la documentación 
 # Aquí puede ir la segunda parte 
 /* 
 * Utiliza este comentario para explicar algo 
 * que requeriría de varias líneas 
 * o incluso varios párrafos para explicarlo 
 */ 
 ?>
    Anuncio

Consejos

  • Los comentarios en HTML y en PHP son diferentes, por lo tanto cuando vayas a desarrollar scripts (combinación de código HTML y PHP), ten cuidado de no mezclar los comentarios.
  • Por ejemplo, en el código que aparece a continuación, hay un documento de HTML, pero de todas formas se ejecuta código PHP. Si colocas un comentario en HTML dentro de las etiquetas de PHP, podría producirse un error.
    • <!--<div id="ejemplo"><?php echo 'hola'; ?></div>-->
Anuncio

wikiHows relacionados

Cómo
ejecutar un programa desde el símbolo del sistema en Linux
Cómo
convertir de decimal a hexadecimal
Cómo
formatear texto como código en Discord
Cómo cambiar un código de cerradura de Kwikset
Cómo
verificar la versión de PHP
Cómo
hacer un programa usando Bloc de notas
Cómo
establecer el ancho y la altura de una imagen en HTML
Cómo comentar múltiples líneas en Python: formato y accesos directos
Cómo
usar el comando net send
Cómo
ejecutar un archivo Python desde el Símbolo del sistema de Windows
Cómo
crear un archivo EXE
Cómo
abrir un archivo SQL
Cómo
crear un archivo ejecutable en Eclipse
Cómo cambiar códigos de usuario de 4 dígitos en cerraduras Schlage
Anuncio

Referencias

  1. ↑ http://www.w3schools.com/php/php_syntax.asp
  2. ↑ http://php.net/manual/en/language.basic-syntax.comments.php
  3. ↑ https://sendgrid.com/docs/Integrate/Code_Examples/php.html
  4. ↑ http://www.w3schools.com/php/php_form_complete.asp

Acerca de este wikiHow

En otros idiomas
Esta página ha recibido 24 160 visitas.

¿Te ayudó este artículo?

Anuncio