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:

LibrosWeb ahora es UniWebSidad
- 204
LibrosWeb, una de las mejores referencias en Internet para aprender web, se ha reciclado tras 12 años de existencia. ¡Mi enhorabuena!
Eliminar el comportamiento por defecto de todos los enlaces de una web
- 77
Ejercicio javascript dónde se inhabilitan todos los enlaces al cargar una web. Al hacer click en un botón se activan de nuevo. Incluye solución.
Ejercicio – ¿Qué hora es? Programación de un reloj muy sencillo en JS
- 181
Ejemplo de programación de un script que devuelve una hora con formato personalizado hh:mm:ss.
Crear, modificar, eliminar y detectar cookies con Javascript
- 1170
En esta entrada explicamos los tipos de cookies que existen y mostramos una biblioteca de funciones que nos permite crear, modificar, eliminar y detectar cookies con javscript.
¿Se pueden hacer listas númeradas negativas con HTML?
- 43
Ejemplos de listas numeradas negativas. Incluye código e imágenes del resultado final con distintas opciones.
Como contar vocales y espacios en blanco en un texto mediante javascript
- 219
Ejercicio con solución dónde se muestra como hacer un script que cuenta todas las vocales y espacios en blanco de un texto introducido por el usario.
Anclas html
- 598
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...
Qué es un favicon y para que sirve
- 177
¿Eres de los que se fija en todos los detalles de una página web cuando navega? Entonces el favicon es para ti. En esta entrada te explico que es y para que sirve.
Ejercicio JS – Rellenar contenidos usando el DOM
- 147
Serie de ejercicios resueltos del tutorial Javacript. Uso básico del DOM. Incluye el repaso básico de teoria a leer y explicación.
Scope de las variables en javascript
- 395
En esta entrada vamos a hablar sobre el ámbito (scope) de las variables en javascript. Voy a suponer que ya sabes declarar y usar funciones y que  también tienes claro el concepto de variable y su sin...
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.