Resumen de como comentar código en html, css y javascript

Resumen de como comentar código en html, css y javascript

Print Friendly, PDF & Email
Resumen de como comentar código en html, css y javascript
Valora esta entrada
Existen páginas web pequeñas y desarrollos que requieren de meses hasta su finalización.

Durante la fase de creación de una página web es también probable que intervengan equipos de profesionales que necesiten entenderse entre ellos.

O tal vez que simplemente estemos aprendiendo.

Para todos estos casos es muy útil hacer uso de los comentarios.

Los comentarios son instrucciones que en programación nos permiten dejar anotaciones en el código sin que interfieran en el resultado final por pantalla de un proyecto.

En todos los lenguajes de programación existe la opción de comentar.

La entrada de hoy es un resumen dónde explicamos como se comenta en los principales lenguajes de frontend: HTML, CSS y Javascript.

comentar código en html, css, js

Comentar código en HTML

Escribiremos dentro del html

<!– todo el código html que queramos comentar –>

Es importante no dejarse el signo de admiración.

No se puede escribir dentro del CSS ni del Javascript.

Comentar código en CSS

/*

todo el código de una línea

todo el código de otra línea

*/

Vigilar siempre con poner los asteriscos después y antes respectivamente de las contra barras.

Comentar código en Javascript.

Para comentar una línea

// todo el código de una línea

Para comentar varias líneas

/*

todo el código de una línea

todo el código de otra línea

*/

Consideraciones a tener en cuenta durante la fase de producción

En función del volumen de un proyecto web típicamente se redacta una memoria web dónde se explica todo el pliegue de especificaciones técnicas del proyecto y se detalla el funcionamiento de este.

Esto incluye dejar comentarios en la web.

Es una buena praxis que cualquier nuevo implementador o desarrollador que retome la web lo pueda hacer con facilidad.

Para ello seremos muy cuidadosos escribiendo un código bien ordenado y explicado.

Sin embargo hay ocasiones en las que cada línea cuenta y típicamente se eliminan todos los comentarios.

Lo más importante es que aquellos comentarios personales que no aporten información útil al proyecto los elimines. Valoraciones personales, …

Piensa que cualquier cosa que escribas estará siempre expuesto a la opinión de cualquier persona que decida inspeccionar la página web!

¡Hey querido lector!

Espero que esta entrada te sea útil y que la próxima vez que tengas que comentar no tengas dudas entre html, css y javascript.

Nos vemos mañana con un nuevo contenido.

Foto a partir de Carlos Muza en Unsplash

Entradas relacionadas:

Como funcionan los frameset de html. ¡Cuidado que están obsoletos!
- 237
El uso de framesets está completamente desaconsejado. Son etiquetas obsoletas. Sin embargo en esta entrada recuperamos su uso y las repasamos. ¡Nunca se sabe si algún día volverán a ser de utilidad!...
La propiedad overflow
- 16
Resumen de uso de la propiedad de overflow de CSS. Apuntes de teoría del curso IFCD0110 del curso confección y publicación de páginas web.
Imágenes en html: la etiqueta img
- 356
Hoy en día se nos hace difícil imaginar aquellas primeras páginas web sin imágenes. La etiqueta de html se propuso por primera vez en 1993 por Marc Andreessen. En esta entrada presentamos la etiqueta...
Ejercicio JS – Crear un cronómetro con javascript
- 34
Completo cronómetro JS dónde se usa setInterval, addEventListener, removeEventListener y se repasan conceptos de CSS. Incluye solución.
Anclas html
- 423
Anteriormente hemos visto que es un enlace y como se construye mediante una etiqueta y cuales son los atributos más importantes que lo acompañan. Hoy vamos a ver una de las utilidades más prácticas d...
Ejemplo de centrado vertical y horizontal con CSS
- 51
Ejemplo explicado sobre como centrar verticalmente y horizontalmente una caja dentro de otra mediante position relative y absolute.
Resumen de atributos html para ayudarnos a memorizar
- 193
En esta entrada hago un ejercicio mental repasando el conjunto de atributos típicos usados en HTML. ¿Cuantos dirías que salen? ¿20, 30, 40, más?
Enlaces en html: la etiqueta a
- 151
La web sería muy distinta a como la conocemos hoy de no ser por Tim Berners-Lee y la invención en 1989 de la etiqueta enlace. El hipervínculo hizo posible incorporar a documentos estructurados y marca...
Meta etiquetas en HTML : meta tags
- 476
Las meta etiquetas son un tipo de tags que se escriben en la cabecera de un documento web que aportan información técnica a los motores de búsqueda sobre como deben leer nuestro sitio web. Vemos los t...
Colores CSS para web
- 294
Existen distintas formas de indicar los colores que queremos dar a los elementos de un documento. Básicamente necesitamos dominar los colores RGB, RGBa y Hexadecimal. Se muestran varios ejemplos de us...
Francesc Ricart
hola@francescricart.com

Soy un ingeniero industrial a quién le apasiona aprender y enseñar. En el mundo del marketing online he encontrado una de mis pasiones. Ejerzo como docente ocupacional y privado para empresas. Y también hago consultoría web para PIMES, autónomos y otros emprendedores como yo. Ayudo a las empresas en cualquier temática relacionada con su presencia digital y herramientas web. Aunque mi especialidad es el posicionamiento en buscadores (SEO). A nivel de formación lo que más feliz me hace es que un alumno haga de mi pasión una forma de vida y le ayude a encontrar trabajo. A nivel de negocios ayudo a empresarios a desenvolverse con soltura en el mundo digital y les animo a hacer cada vez más cosas que nunca hubieran imaginado que ellos también podían hacer. En este camino les ayudo haciendo todo aquello dónde ellos no llegan y crecemos juntos. Encontraréis más acerca de mi en la página sobre mi

No hay comentarios

Escribir un comentario

  Acepto la política de privacidad

Responsable: FRANCESC RICART MUÑOZ.

Finalidad: Gestionar los comentarios que realizas en este blog.

Destinatarios: No se cederán datos a terceros, salvo obligación legal.

Derechos: Tienes derecho a acceder, rectificar y suprimir los datos, así como otros derechos, como se explica en la política de privacidad.