NorfiPC
NorfiPC » Códigos » Comentarios

Como comentar y agregar comentarios en HTML, PHP, CSS y JavaScript



Insertar anotaciones y texto en el código fuente de páginas, archivos de estilo y scripts, que no sean procesadas por el navegador y sin que afecten ni interfieran en su funcionamiento. Añadir notas, aclaraciones e indicaciones en todos los tipos de archivos usados en la web.
Como comentar y agregar comentarios en HTML, PHP, CSS y JavaScript
Es de mucha utilidad agregar comentarios al HTML de las páginas, al código PHP, los scripts y archivos CSS.
Este método es usado por los desarrolladores, principalmente en plantillas, librerías y archivos de código abierto para argumentar y explicar líneas de código o secciones completas.
Los comentarios ayudan a comprender el funcionamiento de elementos, etiquetas, reglas o de funciones, indican opciones disponibles, aclararan funcionalidades y la sintaxis, a todo el que use cualquiera de estos archivos.
Incluso para nosotros mismos pueden ser de gran utilidad, para recordarnos aspectos claves que podemos olvidar.
En este sencillo artículo compartimos todas las formas de comentar archivos, HTML, PHP, CSS y JavaScript.
También es de utilidad conocerlos para todos los que en alguna ocasión observan el código fuente de cualquiera de estos archivos.



Los comentarios en informática


En informática los diferentes lenguajes de programación especifican como insertar comentarios, que entenderán correctamente los programas que los interpretan.
En algunos casos son diferentes y otros aceptan varios de ellos.



Como insertar y agregar comentarios en HTML


En los archivos HTML cualquier grupo de caracteres, una línea o una sección completa a comentar, se encierra de la siguiente forma:
<!-- ESTO ES UN COMENTARIO -->
Cuando se trata de un bloque o de varias líneas, algunos agregan dos barras a la etiqueta de cierre para asegurar la compatibilidad con navegadores antiguos, por ejemplo:
<!--
ESTE BLOQUE
ES SOLO
UN COMENTARIO
//-->
Los navegadores reconocen estas etiquetas e ignoran su contenido.
Este método se aplica por igual a archivos en formato XML.
Si usamos un editor HTML como Notepad+ o cualquier otro, veremos que el código de la sección encerrada se torna de color verde, color predeterminado para indicar comentarios.
Todos ellos facilitan la acción de crear los comentarios, seleccionando los caracteres y usando alguna opción en el menú o un comando.
No obstante siempre se pueden agregar manualmente las etiquetas mencionadas.
En algunos casos en HTML se insertan instrucciones destinadas a versiones específicas de Internet Explorer, las que son interpretadas como comentarios por el resto de los navegadores.
Por ejemplo:
<!--[if lt IE 9]><script src=script.js"></script><![endif]-->



Como insertar y agregar comentarios en PHP


En las páginas servidas como PHP o en los scripts que usan este lenguaje de programación, se pueden comentar líneas o secciones del código de varias formas:
1- Usando el método de C que consiste en anteponer una barra y un asterisco y cerrar la línea a comentar de forma inversa, por ejemplo:
/* Esto es un comentario para una línea 
	o para un bloque completo */
2- Usando el método implementado en C++, Java y Delphi, aún más sencillo, que consiste en anteponer dos barras al comienzo de cada línea, de la siguiente forma:
//Esta línea esta comentada
3- Usando el método de Perl, Python y Ruby.
Consiste en anteponer el carácter de almohadilla (#) a la línea a comentar. Por ejemplo:
#Otra forma de comentar una línea en PHP
Cualquiera de los métodos anteriores funciona, aunque para bloques solo se debe emplear el primero de ellos.



Como insertar y agregar comentarios en JavaScript


En los archivos JavaScript es sumamente fácil comentar cualquier línea de código.
Solo es necesario como en C++ agregar al comienzo de la línea dos barras, de la siguiente forma:
// ESTO ES UN COMENTARIO
También se puede emplear como en PHP, el método de C para comentar bloques completos:
/*
   TODO ESTE BLOQUE 
   SE CONSIDERA UN COMENTARIO
*/
En este caso se debe de comprobar que el código no contenga alguna instrucción con los caracteres */ que pueda romper y bloquear su funcionamiento.
El método de comentar en HTML también se puede emplear en JavaScript para una línea, pero sin la etiqueta de cierre que es ignorada por el intérprete.
Por ejemplo:
// ESTO ES UN COMENTARIO
<!-- ESTO TAMBIÉN
<!-- --> ESTO TAMBIÉN
<!-- ESTO NO FUNCIONA --> 



Como insertar y agregar comentarios en CSS


Los archivos CSS generalmente son los que más comentarios requieren.
Aunque aumentan su tamaño, siempre resultan de utilidad y en muchas ocasiones es necesario comentar ciertas reglas o propiedades con su valor, para facilitar su comprensión o explicar su uso.
Si los archivos son comprimidos para optimizarlos para la web, los comentarios desaparecen.
En los archivos CSS y en el código de estilo insertado inline en las páginas, se pueden comentar las líneas o secciones de distintas formas.
Para comentar una línea se encierra entre dos barras y asteriscos de la siguiente forma:
/* COMENTARIO */
El comentario también se puede usar a continuación de la propiedad y el valor que le corresponde.
Por ejemplo:
body {
  font-size: 14px;  /* Tamaño de fuente de la página */
}
Para comentar una sección más extensa se emplea el mismo método, pero agregando un asterisco al comienzo de cada línea, incluyendo líneas en blanco.
Por ejemplo:
/**
 * CONTENIDO
 *
 *CONFIGURACIÓN
 * Esta sección solo contiene reglas…
*/
Algunos desarrolladores agregan un signo de interrogación a continuación de la apertura, para evitar que el comentario no sea eliminado al comprimir el CSS, aunque no existe garantía alguna.
Por ejemplo:
/*!
 * Bootstrap v3.3.7 (http://getbootstrap.com)
 * Copyright 2011-2016 Twitter, Inc.
*/
Muchos desarrolladores han convertido los comentarios en el CSS, como una especie de arte ASCII que los embellecen, aunque a costa de más espacio.
Por ejemplo:
/*------------------------- ----------*\
               SECCIÓN
\*------------------------------------*/

Páginas relacionadas



Comparte esta página




Sígueme en las redes sociales


Sígueme en Google Plus Sígueme en Facebook Sígueme en Twitter Sígueme en Pinterest





 
Inicio | Mapa del sitio | Sobre mí | RSS | Buscar