Comentar en HTML y en otros lenguajes de programación

Comentar en HTML y en otros lenguajes de programación

¿Sabes comentar en HTML? Si eres un iniciando en el mundo del desarrollo web, pronto descubrirás que en el código fuente de cualquier lenguaje de programación, puedes dejar pequeñas líneas de código que a ti o a otros desarrolladores, os pueden resultar de mucha utilidad. Estos son los llamados comentarios en HTML.

Veamos ejemplos prácticos y como se realizan en algunos de los lenguajes de desarrollo más comunes.

¿Qué son los comentarios en programación?

Para explicarlo vamos a poner como ejemplo los comentarios en HTML. Estos comentarios son líneas de texto recogidas entre dos etiquetas específicas, y que el navegador no mostrará en pantalla. Este texto aunque no se muestra en pantalla, el navegador si que las leerá cuando examine el documento HTML.

¿Para qué sirven los comentarios en programación?

Como desarrollador web te encontrarás, en alguna ocasión, inmerso en un proyecto de gran envergadura donde necesites hacer uso de anotaciones dentro del código fuente. Estas anotaciones te servirán cuando hayas avanzado mucho en el proyecto, o bien cuando lo retomes después de varias semanas (o años). Créeme, te alegrarás mucho cuando te encuentres con esas anotaciones en el código, ya que de un rápido vistazo recordarás por qué utilizaste ese código y no otro, o bien gracias a los mismos, podrás ubicarte dentro del proyecto rápidamente.

Comentarios HTML

Hay otras ocasiones, sobre todo cuando tratas de solventar algún error, que lo usarás para comentar un bloque entero de código y así descubrir, por la ancestral técnica del ensayo y error, que parte de tu web es la que está fallando, y podrás así solucionarlo.

A tener en cuenta, es no dejar mensajes sin sentido en el código, o que a futuro pueda dañar tu imagen con tus clientes. Te parecerá una tontería, pero no te imaginas la de veces que se ven estos comentarios HTML por ejemplo con texto no apto para todos los públicos.

Por último te recomiendo no abusar de este recurso. El motivo es que aunque este comentario que dejas en el código no se vea en pantalla, el navegador sí lo lee. Por lo que, cuantas más lineas de código ingreses, más lineas de código leerá el navegador y más tiempo tardará en cargar la página. Obviamente no hablamos de dejar pequeñas anotaciones, sino de dejar párrafos enteros como si estuvieras escribiendo una novela. Esto afectará en varios milisegundos la carga de la web, y ya sabes que en el mundo del SEO cada milisegundo cuenta.

Comentarios en los diferentes lenguajes de programación

Pasamos a ver cómo comentar en HTML y en otros lenguajes de programación. Los lenguajes de programación que veremos a continuación son los siguientes:

Cómo comentar en HTML

Comentar en HTML5 es realmente sencillo. Dentro de tu código deberás abrir una etiqueta HTML como haces habitualmente, con el símbolo de “menor que”. Seguido irá un cierre de exclamación y dos guiones.

Para cerrar el comentario deberás poner dos guiones y luego el símbolo de “mayor que”.

<!-- Aquí puedes escribir tu comentario -->

Comentar en código CSS 3

Otro de los lenguajes que siendo desarrollador web usarás con total seguridad, es el lenguaje CSS3.

Como sabrás, este lenguaje se usa para “vestir” tu estructura HTML y dejar la web atractiva visualmente. Bien, pues debes saber que también puedes comentar CSS. De hecho, te recomiendo encarecidamente dediques un poco de tiempo a estructurar bien tu hoja de estilos. Debes dejar cada sección bien segmentada para que en el futuro te sea muy sencillo encontrar los diferentes selectores del código. Créeme, es sabio consejo.

Bien, para comentar en CSS lo que debemos hacer es lo siguiente:

Primero abriremos el comentario con una ” / ” seguido de un asterisco *. A partir de ahí podremos escribir el comentario. Para cerrar el mismo, debemos escribir los caracteres anteriores pero en orden inverso. Es decir, primero el * seguido de ” / “.

/* Aquí puedes escribir tu comentario */

Comentarios en JavaScript

En JavaScript tenemos dos maneras de insertar comentarios en nuestro código.

  • Comentarios en línea
  • Comentarios multi-línea

Comentarios en línea JavaScript

Los comentarios breves, para enunciar un bloque de texto o una función especifica, pueden realizarse iniciando el comentario con una doble ” / “. Un ejemplo sería el siguiente:

// Aquí puedes escribir tu comentario

Comentarios multilinea JavaScript

Si lo que buscamos es comentar un bloque entero de un código JavaScript para por ejemplo, tener bien localizado cuando empieza y acaba ese código y facilitar así su localización, la forma de hacerlo es igual que en los comentarios CSS. Se haría de la siguiente forma:

/* 
Comentarios en JavaScript
Autor: Caronte Web Studio
*/

Comentar en JavaScript

Comentarios en Python

Si estamos programando en Pyhton y queremos dejar anotaciones para otros desarrolladores o para nosotros mismos, la forma de realizarlo es mu sencillo. Seria introduciendo una almohadilla (#) al inicio del texto que vayamos a introducir. Un ejemplo:

# Aquí puedes escribir tu comentario

Python también nos permite comentar en una línea donde tengamos una sentencia justo a continuación de la misma. Con esto podemos detallar de forma muy clara para que sirve cada linea de nuestro código. Un ejemplo:

print "Texto que imprime la sentencia print" # Aquí escribimos el comentario

Conclusión

Como has podido ver, en prácticamente todos los lenguajes de programación se puede comentar el código, ya que es una herramienta fundamental para el desarrollador. A la hora de escribir el código, y también a la de retomar su proyecto o el de otro.

En definitiva, no dejes de comentar tu código. Y si tienes un minuto, también se agradecen comentarios en esta publicación 🙂

¡Hasta la próxima!

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Puedes usar estas etiquetas y atributos HTML:

<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>

Volver al blog