¿Cómo agregar comentarios en PHP, HTML, CSS, JS?

¿Cómo agregar comentarios en PHP, HTML, CSS, JS?

Quienes nos dedicamos al diseño y desarrollo web sabemos lo útil que puede llegar a ser colocar comentarios de referencia en nuestro código. Este tipo de comentarios pueden ayudarte a saber para qué colocaste ese código o el porqué lo editaste e incluso para desactivar temporalmente alguna función o estilo. Lo mejor de todo es que los comentarios no son visibles en el navegador y el usuario promedio no sabrá que están ahí.

A continuación te presentamos cómo hacer comentarios para código HTML, CSS, JS Y PHP

HTML

Para comentar HTML solo necesitas agregar <!– antes y la etiqueta de cierre — > después de tu código. Quedaría de la siguiente manera:

<!-- Aqui puede ir tu comentario -->
</div> 
</div>
</footer>
</body>
</html>

<!-- Así se desactiva el código

<div> </div> -->

CSS

Se inicia con /* y termina con */, en este ejemplo desactivaremos de manera un estilo CSS, quedando de la siguiente manera:

  /* Así se comenta el estilo */
  .main {
margin:0auto;
width:940px;
position:relative;
/* Agregando diagonal y asterisco al inicio y final se desactiva el estilo

  h2 
font-size:26px;
line-height:28px;
}
*/

PHP

Existen dos formas para comentar PHP

1.- Comentando en una sola línea para apuntes rápidos o desactivar temporalmente una línea de código:

// Comentario de referencia

#define('TABLE_HEADING_WRITABLE', 'Writable');

2.- Comentarios de multiples líneas, para desactivar varias líneas de código PHP o comentarlas. Es necesario añadir /* antes y */ después del código:

/*$Id$
osCommerce, Open Source E-Commerce Solutions
http://www.oscommerce.com
Copyright (c) 2010 osCommerce
Released under the GNU General Public License
  */

JavaScript

Existen dos fomas de comentario que puedes agregar:

1.- Comentar en una sola línea, Es necesario agregar // antes de su código o texto. Todo el texto a la derecha de ellos será ignorado hasta la línea siguiente. Quedaría así:

//verify if value is in the array
  functionin_array(value, array)
  {
for(vari inarray)
if(array[i] == value)
returntrue;
returnfalse;
}

2.- Comentar multiples líneas, sirve para anular código de manera momentanea:

/*function in_array(value, array){
for (var i in array)
    if (array[i] == value)
    return true;
        return false;}*/
</script>

Como te daras cuenta, saber comentar tú código es muy útil y sencillo. Ojalá este pequeño tutorial te sea útil. Nos leemos en la siguiente entrega.

Web